1 package SL::Controller::CsvImport::Order;
6 use List::MoreUtils qw(any);
9 use SL::Controller::CsvImport::Helper::Consistency;
11 use SL::DB::OrderItem;
13 use SL::DB::PaymentTerm;
15 use SL::DB::Department;
16 use SL::DB::PriceFactor;
17 use SL::DB::Pricegroup;
23 use parent qw(SL::Controller::CsvImport::BaseMulti);
26 use Rose::Object::MakeMethods::Generic
28 'scalar --get_set_init' => [ qw(settings languages_by parts_by contacts_by ct_shiptos_by price_factors_by pricegroups_by) ],
34 $self->class(['SL::DB::Order', 'SL::DB::OrderItem']);
37 sub set_profile_defaults {
40 $self->controller->profile->_set_defaults(
41 order_column => $::locale->text('Order'),
42 item_column => $::locale->text('OrderItem'),
43 max_amount_diff => 0.02,
51 return { map { ( $_ => $self->controller->profile->get($_) ) } qw(order_column item_column max_amount_diff) };
55 sub init_cvar_configs_by {
58 my $item_cvar_configs = SL::DB::Manager::CustomVariableConfig->get_all(where => [ module => 'IC' ]);
59 $item_cvar_configs = [grep { $_->has_flag('editable') } @{ $item_cvar_configs }];
62 $ccb->{class}->{'SL::DB::Order'} = [];
63 $ccb->{class}->{'SL::DB::OrderItem'} = $item_cvar_configs;
64 $ccb->{row_ident}->{$self->_order_column} = [];
65 $ccb->{row_ident}->{$self->_item_column} = $item_cvar_configs;
74 my $profile = $self->SUPER::init_profile;
76 # SUPER::init_profile sets row_ident to the translated class name
77 # overwrite it with the user specified settings
78 foreach my $p (@{ $profile }) {
79 if ($p->{class} eq 'SL::DB::Order') {
80 $p->{row_ident} = $self->_order_column;
82 if ($p->{class} eq 'SL::DB::OrderItem') {
83 $p->{row_ident} = $self->_item_column;
87 foreach my $p (@{ $profile }) {
88 my $prof = $p->{profile};
89 if ($p->{row_ident} eq $self->_order_column) {
91 delete @{$prof}{qw(delivery_customer_id delivery_vendor_id proforma quotation amount netamount)};
93 if ($p->{row_ident} eq $self->_item_column) {
95 delete @{$prof}{qw(trans_id)};
103 sub setup_displayable_columns {
106 $self->SUPER::setup_displayable_columns;
108 $self->add_displayable_columns($self->_order_column,
109 { name => 'datatype', description => $self->_order_column . ' [1]' },
110 { name => 'closed', description => $::locale->text('Closed') },
111 { name => 'currency', description => $::locale->text('Currency') },
112 { name => 'currency_id', description => $::locale->text('Currency (database ID)') },
113 { name => 'cusordnumber', description => $::locale->text('Customer Order Number') },
114 { name => 'delivered', description => $::locale->text('Delivered') },
115 { name => 'delivery_term_id', description => $::locale->text('Delivery terms (database ID)') },
116 { name => 'delivery_term', description => $::locale->text('Delivery terms (name)') },
117 { name => 'employee_id', description => $::locale->text('Employee (database ID)') },
118 { name => 'intnotes', description => $::locale->text('Internal Notes') },
119 { name => 'marge_percent', description => $::locale->text('Margepercent') },
120 { name => 'marge_total', description => $::locale->text('Margetotal') },
121 { name => 'notes', description => $::locale->text('Notes') },
122 { name => 'ordnumber', description => $::locale->text('Order Number') },
123 { name => 'quonumber', description => $::locale->text('Quotation Number') },
124 { name => 'reqdate', description => $::locale->text('Reqdate') },
125 { name => 'salesman_id', description => $::locale->text('Salesman (database ID)') },
126 { name => 'shippingpoint', description => $::locale->text('Shipping Point') },
127 { name => 'shipvia', description => $::locale->text('Ship via') },
128 { name => 'transaction_description', description => $::locale->text('Transaction description') },
129 { name => 'transdate', description => $::locale->text('Order Date') },
130 { name => 'verify_amount', description => $::locale->text('Amount (for verification)') . ' [2]' },
131 { name => 'verify_netamount', description => $::locale->text('Net amount (for verification)') . ' [2]'},
132 { name => 'taxincluded', description => $::locale->text('Tax Included') },
133 { name => 'customer', description => $::locale->text('Customer (name)') },
134 { name => 'customernumber', description => $::locale->text('Customer Number') },
135 { name => 'customer_id', description => $::locale->text('Customer (database ID)') },
136 { name => 'vendor', description => $::locale->text('Vendor (name)') },
137 { name => 'vendornumber', description => $::locale->text('Vendor Number') },
138 { name => 'vendor_id', description => $::locale->text('Vendor (database ID)') },
139 { name => 'language_id', description => $::locale->text('Language (database ID)') },
140 { name => 'language', description => $::locale->text('Language (name)') },
141 { name => 'payment_id', description => $::locale->text('Payment terms (database ID)') },
142 { name => 'payment', description => $::locale->text('Payment terms (name)') },
143 { name => 'taxzone_id', description => $::locale->text('Tax zone (database ID)') },
144 { name => 'taxzone', description => $::locale->text('Tax zone (description)') },
145 { name => 'cp_id', description => $::locale->text('Contact Person (database ID)') },
146 { name => 'contact', description => $::locale->text('Contact Person (name)') },
147 { name => 'department_id', description => $::locale->text('Department (database ID)') },
148 { name => 'department', description => $::locale->text('Department (description)') },
149 { name => 'globalproject_id', description => $::locale->text('Document Project (database ID)') },
150 { name => 'globalprojectnumber', description => $::locale->text('Document Project (number)') },
151 { name => 'globalproject', description => $::locale->text('Document Project (description)') },
152 { name => 'shipto_id', description => $::locale->text('Ship to (database ID)') },
155 $self->add_cvar_columns_to_displayable_columns($self->_item_column);
157 $self->add_displayable_columns($self->_item_column,
158 { name => 'datatype', description => $self->_item_column . ' [1]' },
159 { name => 'cusordnumber', description => $::locale->text('Customer Order Number') },
160 { name => 'description', description => $::locale->text('Description') },
161 { name => 'discount', description => $::locale->text('Discount') },
162 { name => 'lastcost', description => $::locale->text('Lastcost') },
163 { name => 'longdescription', description => $::locale->text('Long Description') },
164 { name => 'marge_percent', description => $::locale->text('Margepercent') },
165 { name => 'marge_total', description => $::locale->text('Margetotal') },
166 { name => 'ordnumber', description => $::locale->text('Order Number') },
167 { name => 'parts_id', description => $::locale->text('Part (database ID)') },
168 { name => 'partnumber', description => $::locale->text('Part Number') },
169 { name => 'position', description => $::locale->text('position') },
170 { name => 'project_id', description => $::locale->text('Project (database ID)') },
171 { name => 'projectnumber', description => $::locale->text('Project (number)') },
172 { name => 'project', description => $::locale->text('Project (description)') },
173 { name => 'price_factor_id', description => $::locale->text('Price factor (database ID)') },
174 { name => 'price_factor', description => $::locale->text('Price factor (name)') },
175 { name => 'pricegroup_id', description => $::locale->text('Price group (database ID)') },
176 { name => 'pricegroup', description => $::locale->text('Price group (name)') },
177 { name => 'qty', description => $::locale->text('Quantity') },
178 { name => 'reqdate', description => $::locale->text('Reqdate') },
179 { name => 'sellprice', description => $::locale->text('Sellprice') },
180 { name => 'serialnumber', description => $::locale->text('Serial No.') },
181 { name => 'subtotal', description => $::locale->text('Subtotal') },
182 { name => 'unit', description => $::locale->text('Unit') },
187 sub init_languages_by {
190 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $self->all_languages } } ) } qw(id description article_code) };
196 my $all_parts = SL::DB::Manager::Part->get_all;
197 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_parts } } ) } qw(id partnumber ean description) };
200 sub init_contacts_by {
203 my $all_contacts = SL::DB::Manager::Contact->get_all;
206 # by customer/vendor id _and_ contact person id
207 $cby->{'cp_cv_id+cp_id'} = { map { ( $_->cp_cv_id . '+' . $_->cp_id => $_ ) } @{ $all_contacts } };
208 # by customer/vendor id _and_ contact person name
209 $cby->{'cp_cv_id+cp_name'} = { map { ( $_->cp_cv_id . '+' . $_->cp_name => $_ ) } @{ $all_contacts } };
214 sub init_ct_shiptos_by {
217 my $all_ct_shiptos = SL::DB::Manager::Shipto->get_all(query => [module => 'CT']);
220 # by trans_id _and_ shipto_id
221 $sby->{'trans_id+shipto_id'} = { map { ( $_->trans_id . '+' . $_->shipto_id => $_ ) } @{ $all_ct_shiptos } };
226 sub init_price_factors_by {
229 my $all_price_factors = SL::DB::Manager::PriceFactor->get_all;
230 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_price_factors } } ) } qw(id description) };
233 sub init_pricegroups_by {
236 my $all_pricegroups = SL::DB::Manager::Pricegroup->get_all;
237 return { map { my $col = $_; ( $col => { map { ( $_->$col => $_ ) } @{ $all_pricegroups } } ) } qw(id pricegroup) };
243 $self->controller->track_progress(phase => 'building data', progress => 0);
246 my $num_data = scalar @{ $self->controller->data };
247 foreach my $entry (@{ $self->controller->data }) {
248 $self->controller->track_progress(progress => $i/$num_data * 100) if $i % 100 == 0;
250 if ($entry->{raw_data}->{datatype} eq $self->_order_column) {
251 $self->handle_order($entry);
252 } elsif ($entry->{raw_data}->{datatype} eq $self->_item_column && $entry->{object}->can('part')) {
253 $self->handle_item($entry);
255 $self->handle_cvars($entry, sub_module => 'orderitems');
261 $self->add_info_columns($self->_order_column,
262 { header => $::locale->text('Customer/Vendor'), method => 'vc_name' });
263 # Todo: access via ->[0] ok? Better: search first order column and use this
264 $self->add_columns($self->_order_column,
265 map { "${_}_id" } grep { exists $self->controller->data->[0]->{raw_data}->{$_} } qw(payment delivery_term language department globalproject taxzone cp currency));
266 $self->add_columns($self->_order_column, 'globalproject_id') if exists $self->controller->data->[0]->{raw_data}->{globalprojectnumber};
267 $self->add_columns($self->_order_column, 'cp_id') if exists $self->controller->data->[0]->{raw_data}->{contact};
269 $self->add_info_columns($self->_item_column,
270 { header => $::locale->text('Part Number'), method => 'partnumber' });
271 # Todo: access via ->[1] ok? Better: search first item column and use this
272 $self->add_columns($self->_item_column,
273 map { "${_}_id" } grep { exists $self->controller->data->[1]->{raw_data}->{$_} } qw(project price_factor pricegroup));
274 $self->add_columns($self->_item_column, 'project_id') if exists $self->controller->data->[1]->{raw_data}->{projectnumber};
276 $self->add_cvar_raw_data_columns();
278 $self->add_items_to_order();
279 $self->handle_prices_and_taxes();
282 # If order has errors set error for orderitems as well
284 foreach my $entry (@{ $self->controller->data }) {
286 if ($entry->{raw_data}->{datatype} eq $self->_order_column) {
287 $order_entry = $entry;
288 } elsif ( defined $order_entry
289 && $entry->{raw_data}->{datatype} eq $self->_item_column
290 && scalar @{ $order_entry->{errors} } > 0 ) {
291 push @{ $entry->{errors} }, $::locale->text('Error: Invalid order for this order item');
298 my ($self, $entry) = @_;
300 my $object = $entry->{object};
303 if (any { $entry->{raw_data}->{$_} } qw(customer customernumber customer_id)) {
304 $self->check_vc($entry, 'customer_id');
305 $vc_obj = SL::DB::Customer->new(id => $object->customer_id)->load if $object->customer_id;
306 } elsif (any { $entry->{raw_data}->{$_} } qw(vendor vendornumber vendor_id)) {
307 $self->check_vc($entry, 'vendor_id');
308 $vc_obj = SL::DB::Vendor->new(id => $object->vendor_id)->load if $object->vendor_id;
310 push @{ $entry->{errors} }, $::locale->text('Error: Customer/vendor missing');
313 $self->check_contact($entry);
314 $self->check_language($entry);
315 $self->check_payment($entry);
316 $self->check_delivery_term($entry);
317 $self->check_department($entry);
318 $self->check_project($entry, global => 1);
319 $self->check_ct_shipto($entry);
320 $self->check_taxzone($entry);
321 $self->check_currency($entry, take_default => 0);
324 # copy from customer if not given
325 foreach (qw(payment_id language_id taxzone_id currency_id)) {
326 $object->$_($vc_obj->$_) unless $object->$_;
330 $self->handle_salesman($entry);
331 $self->handle_employee($entry);
335 my ($self, $entry) = @_;
337 my $object = $entry->{object};
339 # Check whether or not language ID is valid.
340 if ($object->language_id && !$self->languages_by->{id}->{ $object->language_id }) {
341 push @{ $entry->{errors} }, $::locale->text('Error: Invalid language');
345 # Map name to ID if given.
346 if (!$object->language_id && $entry->{raw_data}->{language}) {
347 my $language = $self->languages_by->{description}->{ $entry->{raw_data}->{language} }
348 || $self->languages_by->{article_code}->{ $entry->{raw_data}->{language} };
351 push @{ $entry->{errors} }, $::locale->text('Error: Invalid language');
355 $object->language_id($language->id);
358 if ($object->language_id) {
359 $entry->{info_data}->{language} = $self->languages_by->{id}->{ $object->language_id }->description;
366 my ($self, $entry) = @_;
368 my $object = $entry->{object};
369 return unless $self->check_part($entry);
371 my $part_obj = SL::DB::Part->new(id => $object->parts_id)->load;
373 # copy from part if not given
374 $object->description($part_obj->description) unless $object->description;
375 $object->longdescription($part_obj->notes) unless $object->longdescription;
376 $object->unit($part_obj->unit) unless $object->unit;
377 $object->sellprice($part_obj->sellprice) unless defined $object->sellprice;
378 $object->lastcost($part_obj->lastcost) unless defined $object->lastcost;
380 # set to 0 if not given
381 $object->discount(0) unless $object->discount;
382 $object->ship(0) unless $object->ship;
384 $self->check_project($entry, global => 0);
385 $self->check_price_factor($entry);
386 $self->check_pricegroup($entry);
390 my ($self, $entry) = @_;
392 my $object = $entry->{object};
394 # Check whether or not part ID is valid.
395 if ($object->parts_id && !$self->parts_by->{id}->{ $object->parts_id }) {
396 push @{ $entry->{errors} }, $::locale->text('Error: Invalid part');
400 # Map number to ID if given.
401 if (!$object->parts_id && $entry->{raw_data}->{partnumber}) {
402 my $part = $self->parts_by->{partnumber}->{ $entry->{raw_data}->{partnumber} };
404 push @{ $entry->{errors} }, $::locale->text('Error: Invalid part');
408 $object->parts_id($part->id);
411 # Map description to ID if given.
412 if (!$object->parts_id && $entry->{raw_data}->{description}) {
413 my $part = $self->parts_by->{description}->{ $entry->{raw_data}->{description} };
415 push @{ $entry->{errors} }, $::locale->text('Error: Invalid part');
419 $object->parts_id($part->id);
422 if ($object->parts_id) {
423 $entry->{info_data}->{partnumber} = $self->parts_by->{id}->{ $object->parts_id }->partnumber;
425 push @{ $entry->{errors} }, $::locale->text('Error: Part not found');
433 my ($self, $entry) = @_;
435 my $object = $entry->{object};
437 my $cp_cv_id = $object->customer_id || $object->vendor_id;
438 return 0 unless $cp_cv_id;
440 # Check whether or not contact ID is valid.
441 if ($object->cp_id && !$self->contacts_by->{'cp_cv_id+cp_id'}->{ $cp_cv_id . '+' . $object->cp_id }) {
442 push @{ $entry->{errors} }, $::locale->text('Error: Invalid contact');
446 # Map name to ID if given.
447 if (!$object->cp_id && $entry->{raw_data}->{contact}) {
448 my $cp = $self->contacts_by->{'cp_cv_id+cp_name'}->{ $cp_cv_id . '+' . $entry->{raw_data}->{contact} };
450 push @{ $entry->{errors} }, $::locale->text('Error: Invalid contact');
454 $object->cp_id($cp->cp_id);
457 if ($object->cp_id) {
458 $entry->{info_data}->{contact} = $self->contacts_by->{'cp_cv_id+cp_id'}->{ $cp_cv_id . '+' . $object->cp_id }->cp_name;
464 sub check_ct_shipto {
465 my ($self, $entry) = @_;
467 my $object = $entry->{object};
469 my $trans_id = $object->customer_id || $object->vendor_id;
470 return 0 unless $trans_id;
472 # Check whether or not shipto ID is valid.
473 if ($object->shipto_id && !$self->ct_shiptos_by->{'trans_id+shipto_id'}->{ $trans_id . '+' . $object->shipto_id }) {
474 push @{ $entry->{errors} }, $::locale->text('Error: Invalid shipto');
481 sub check_price_factor {
482 my ($self, $entry) = @_;
484 my $object = $entry->{object};
486 # Check whether or not price_factor ID is valid.
487 if ($object->price_factor_id && !$self->price_factors_by->{id}->{ $object->price_factor_id }) {
488 push @{ $entry->{errors} }, $::locale->text('Error: Invalid price factor');
492 # Map description to ID if given.
493 if (!$object->price_factor_id && $entry->{raw_data}->{price_factor}) {
494 my $price_factor = $self->price_factors_by->{description}->{ $entry->{raw_data}->{price_factor} };
495 if (!$price_factor) {
496 push @{ $entry->{errors} }, $::locale->text('Error: Invalid price factor');
500 $object->price_factor_id($price_factor->id);
506 sub check_pricegroup {
507 my ($self, $entry) = @_;
509 my $object = $entry->{object};
511 # Check whether or not pricegroup ID is valid.
512 if ($object->pricegroup_id && !$self->pricegroups_by->{id}->{ $object->pricegroup_id }) {
513 push @{ $entry->{errors} }, $::locale->text('Error: Invalid price group');
517 # Map pricegroup to ID if given.
518 if (!$object->pricegroup_id && $entry->{raw_data}->{pricegroup}) {
519 my $pricegroup = $self->pricegroups_by->{pricegroup}->{ $entry->{raw_data}->{pricegroup} };
521 push @{ $entry->{errors} }, $::locale->text('Error: Invalid price group');
525 $object->pricegroup_id($pricegroup->id);
531 sub add_items_to_order {
534 # add orderitems to order
537 foreach my $entry (@{ $self->controller->data }) {
538 # search first/next order
539 if ($entry->{raw_data}->{datatype} eq $self->_order_column) {
541 # next order entry: add collected orderitems to the previous one
542 if (defined $order_entry) {
543 $order_entry->{object}->orderitems(@orderitems);
547 $order_entry = $entry;
549 } elsif ( defined $order_entry && $entry->{raw_data}->{datatype} eq $self->_item_column ) {
550 # collect orderitems to add to order (if they have no errors)
551 # ( add_orderitems does not work here if we want to call
552 # calculate_prices_and_taxes afterwards ...
553 # so collect orderitems and add them at once )
554 push @orderitems, $entry->{object} if (scalar @{ $entry->{errors} } == 0);
557 # add last collected orderitems to last order
558 $order_entry->{object}->orderitems(@orderitems) if $order_entry;
561 sub handle_prices_and_taxes() {
564 # calculate prices and taxes
565 foreach my $entry (@{ $self->controller->data }) {
566 next if @{ $entry->{errors} };
568 if ($entry->{raw_data}->{datatype} eq $self->_order_column && $entry->{object}->orderitems) {
570 $entry->{object}->calculate_prices_and_taxes;
572 $entry->{info_data}->{calc_amount} = $entry->{object}->amount_as_number;
573 $entry->{info_data}->{calc_netamount} = $entry->{object}->netamount_as_number;
577 # If amounts are given, show calculated amounts as info and given amounts (verify_xxx).
578 # And throw an error if the differences are too big.
579 my @to_verify = ( { column => 'amount',
580 raw_column => 'verify_amount',
581 info_header => 'Calc. Amount',
582 info_method => 'calc_amount',
583 err_msg => 'Amounts differ too much',
585 { column => 'netamount',
586 raw_column => 'verify_netamount',
587 info_header => 'Calc. Net amount',
588 info_method => 'calc_netamount',
589 err_msg => 'Net amounts differ too much',
592 foreach my $tv (@to_verify) {
593 # Todo: access via ->[0] ok? Better: search first order column and use this
594 if (exists $self->controller->data->[0]->{raw_data}->{ $tv->{raw_column} }) {
595 $self->add_raw_data_columns($self->_order_column, $tv->{raw_column});
596 $self->add_info_columns($self->_order_column,
597 { header => $::locale->text($tv->{info_header}), method => $tv->{info_method} });
601 foreach my $entry (@{ $self->controller->data }) {
602 next if @{ $entry->{errors} };
603 if ($entry->{raw_data}->{datatype} eq $self->_order_column) {
604 next if !$entry->{raw_data}->{ $tv->{raw_column} };
605 my $parsed_value = $::form->parse_amount(\%::myconfig, $entry->{raw_data}->{ $tv->{raw_column} });
606 if (abs($entry->{object}->${ \$tv->{column} } - $parsed_value) > $self->settings->{'max_amount_diff'}) {
607 push @{ $entry->{errors} }, $::locale->text($tv->{err_msg});
616 my ($self, %params) = @_;
618 # set order number and collect to save
620 foreach my $entry (@{ $self->controller->data }) {
621 next if $entry->{raw_data}->{datatype} ne $self->_order_column;
622 next if @{ $entry->{errors} };
624 if (!$entry->{object}->ordnumber) {
625 my $number = SL::TransNumber->new(type => 'sales_order',
627 $entry->{object}->ordnumber($number->create_unique());
630 push @{ $objects_to_save }, $entry;
633 $self->SUPER::save_objects(data => $objects_to_save);
637 $_[0]->settings->{'order_column'}
641 $_[0]->settings->{'item_column'}