1 package SL::Controller::Order;
4 use parent qw(SL::Controller::Base);
6 use SL::Helper::Flash qw(flash_later);
7 use SL::Presenter::Tag qw(select_tag hidden_tag div_tag);
8 use SL::Locale::String qw(t8);
9 use SL::SessionFile::Random;
14 use SL::Util qw(trim);
20 use SL::DB::PartsGroup;
23 use SL::DB::RecordLink;
25 use SL::DB::Translation;
27 use SL::Helper::CreatePDF qw(:all);
28 use SL::Helper::PrintOptions;
29 use SL::Helper::ShippedQty;
30 use SL::Helper::UserPreferences::PositionsScrollbar;
31 use SL::Helper::UserPreferences::UpdatePositions;
33 use SL::Controller::Helper::GetModels;
35 use List::Util qw(first sum0);
36 use List::UtilsBy qw(sort_by uniq_by);
37 use List::MoreUtils qw(any none pairwise first_index);
38 use English qw(-no_match_vars);
43 use Rose::Object::MakeMethods::Generic
45 scalar => [ qw(item_ids_to_delete is_custom_shipto_to_delete) ],
46 'scalar --get_set_init' => [ qw(order valid_types type cv p multi_items_models all_price_factors search_cvpartnumber show_update_button) ],
51 __PACKAGE__->run_before('check_auth');
53 __PACKAGE__->run_before('recalc',
54 only => [ qw(save save_as_new save_and_delivery_order save_and_invoice save_and_ap_transaction
57 __PACKAGE__->run_before('get_unalterable_data',
58 only => [ qw(save save_as_new save_and_delivery_order save_and_invoice save_and_ap_transaction
69 $self->order->transdate(DateTime->now_local());
70 my $extra_days = $self->{type} eq 'sales_quotation' ? $::instance_conf->get_reqdate_interval :
71 $self->{type} eq 'sales_order' ? $::instance_conf->get_delivery_date_interval : 1;
72 $self->order->reqdate(DateTime->today_local->next_workday(extra_days => $extra_days)) if !$self->order->reqdate;
78 title => $self->get_title_for('add'),
79 %{$self->{template_args}}
83 # edit an existing order
91 # this is to edit an order from an unsaved order object
93 # set item ids to new fake id, to identify them as new items
94 foreach my $item (@{$self->order->items_sorted}) {
95 $item->{new_fake_id} = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
97 # trigger rendering values for second row as hidden, because they
98 # are loaded only on demand. So we need to keep the values from
100 $_->{render_second_row} = 1 for @{ $self->order->items_sorted };
107 title => $self->get_title_for('edit'),
108 %{$self->{template_args}}
112 # edit a collective order (consisting of one or more existing orders)
113 sub action_edit_collective {
117 my @multi_ids = map {
118 $_ =~ m{^multi_id_(\d+)$} && $::form->{'multi_id_' . $1} && $::form->{'trans_id_' . $1} && $::form->{'trans_id_' . $1}
119 } grep { $_ =~ m{^multi_id_\d+$} } keys %$::form;
121 # fall back to add if no ids are given
122 if (scalar @multi_ids == 0) {
127 # fall back to save as new if only one id is given
128 if (scalar @multi_ids == 1) {
129 $self->order(SL::DB::Order->new(id => $multi_ids[0])->load);
130 $self->action_save_as_new();
134 # make new order from given orders
135 my @multi_orders = map { SL::DB::Order->new(id => $_)->load } @multi_ids;
136 $self->{converted_from_oe_id} = join ' ', map { $_->id } @multi_orders;
137 $self->order(SL::DB::Order->new_from_multi(\@multi_orders, sort_sources_by => 'transdate'));
139 $self->action_edit();
146 my $errors = $self->delete();
148 if (scalar @{ $errors }) {
149 $self->js->flash('error', $_) foreach @{ $errors };
150 return $self->js->render();
153 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been deleted')
154 : $self->type eq purchase_order_type() ? $::locale->text('The order has been deleted')
155 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been deleted')
156 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been deleted')
158 flash_later('info', $text);
160 my @redirect_params = (
165 $self->redirect_to(@redirect_params);
172 my $errors = $self->save();
174 if (scalar @{ $errors }) {
175 $self->js->flash('error', $_) foreach @{ $errors };
176 return $self->js->render();
179 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
180 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
181 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
182 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
184 flash_later('info', $text);
186 my @redirect_params = (
189 id => $self->order->id,
192 $self->redirect_to(@redirect_params);
195 # save the order as new document an open it for edit
196 sub action_save_as_new {
199 my $order = $self->order;
202 $self->js->flash('error', t8('This object has not been saved yet.'));
203 return $self->js->render();
206 # load order from db to check if values changed
207 my $saved_order = SL::DB::Order->new(id => $order->id)->load;
210 # Lets assign a new number if the user hasn't changed the previous one.
211 # If it has been changed manually then use it as-is.
212 $new_attrs{number} = (trim($order->number) eq $saved_order->number)
214 : trim($order->number);
216 # Clear transdate unless changed
217 $new_attrs{transdate} = ($order->transdate == $saved_order->transdate)
218 ? DateTime->today_local
221 # Set new reqdate unless changed
222 if ($order->reqdate == $saved_order->reqdate) {
223 my $extra_days = $self->{type} eq 'sales_quotation' ? $::instance_conf->get_reqdate_interval :
224 $self->{type} eq 'sales_order' ? $::instance_conf->get_delivery_date_interval : 1;
225 $new_attrs{reqdate} = DateTime->today_local->next_workday(extra_days => $extra_days);
227 $new_attrs{reqdate} = $order->reqdate;
231 $new_attrs{employee} = SL::DB::Manager::Employee->current;
233 # Create new record from current one
234 $self->order(SL::DB::Order->new_from($order, destination_type => $order->type, attributes => \%new_attrs));
236 # no linked records on save as new
237 delete $::form->{$_} for qw(converted_from_oe_id converted_from_orderitems_ids);
240 $self->action_save();
245 # This is called if "print" is pressed in the print dialog.
246 # If PDF creation was requested and succeeded, the pdf is offered for download
247 # via send_file (which uses ajax in this case).
251 my $errors = $self->save();
253 if (scalar @{ $errors }) {
254 $self->js->flash('error', $_) foreach @{ $errors };
255 return $self->js->render();
258 $self->js_reset_order_and_item_ids_after_save;
260 my $format = $::form->{print_options}->{format};
261 my $media = $::form->{print_options}->{media};
262 my $formname = $::form->{print_options}->{formname};
263 my $copies = $::form->{print_options}->{copies};
264 my $groupitems = $::form->{print_options}->{groupitems};
265 my $printer_id = $::form->{print_options}->{printer_id};
267 # only pdf and opendocument by now
268 if (none { $format eq $_ } qw(pdf opendocument opendocument_pdf)) {
269 return $self->js->flash('error', t8('Format \'#1\' is not supported yet/anymore.', $format))->render;
272 # only screen or printer by now
273 if (none { $media eq $_ } qw(screen printer)) {
274 return $self->js->flash('error', t8('Media \'#1\' is not supported yet/anymore.', $media))->render;
277 # create a form for generate_attachment_filename
278 my $form = Form->new;
279 $form->{$self->nr_key()} = $self->order->number;
280 $form->{type} = $self->type;
281 $form->{format} = $format;
282 $form->{formname} = $formname;
283 $form->{language} = '_' . $self->order->language->template_code if $self->order->language;
284 my $pdf_filename = $form->generate_attachment_filename();
287 my @errors = generate_pdf($self->order, \$pdf, { format => $format,
288 formname => $formname,
289 language => $self->order->language,
290 printer_id => $printer_id,
291 groupitems => $groupitems });
292 if (scalar @errors) {
293 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render;
296 if ($media eq 'screen') {
298 $self->js->flash('info', t8('The PDF has been created'));
301 type => SL::MIME->mime_type_from_ext($pdf_filename),
302 name => $pdf_filename,
306 } elsif ($media eq 'printer') {
308 my $printer_id = $::form->{print_options}->{printer_id};
309 SL::DB::Printer->new(id => $printer_id)->load->print_document(
314 $self->js->flash('info', t8('The PDF has been printed'));
317 # copy file to webdav folder
318 if ($self->order->number && $::instance_conf->get_webdav_documents) {
319 my $webdav = SL::Webdav->new(
321 number => $self->order->number,
323 my $webdav_file = SL::Webdav::File->new(
325 filename => $pdf_filename,
328 $webdav_file->store(data => \$pdf);
331 $self->js->flash('error', t8('Storing PDF to webdav folder failed: #1', $@));
334 if ($self->order->number && $::instance_conf->get_doc_storage) {
336 SL::File->save(object_id => $self->order->id,
337 object_type => $self->type,
338 mime_type => 'application/pdf',
340 file_type => 'document',
341 file_name => $pdf_filename,
342 file_contents => $pdf);
345 $self->js->flash('error', t8('Storing PDF in storage backend failed: #1', $@));
351 # open the email dialog
352 sub action_save_and_show_email_dialog {
355 my $errors = $self->save();
357 if (scalar @{ $errors }) {
358 $self->js->flash('error', $_) foreach @{ $errors };
359 return $self->js->render();
362 my $cv_method = $self->cv;
364 if (!$self->order->$cv_method) {
365 return $self->js->flash('error', $self->cv eq 'customer' ? t8('Cannot send E-mail without customer given') : t8('Cannot send E-mail without vendor given'))
370 $email_form->{to} = $self->order->contact->cp_email if $self->order->contact;
371 $email_form->{to} ||= $self->order->$cv_method->email;
372 $email_form->{cc} = $self->order->$cv_method->cc;
373 $email_form->{bcc} = join ', ', grep $_, $self->order->$cv_method->bcc, SL::DB::Default->get->global_bcc;
374 # Todo: get addresses from shipto, if any
376 my $form = Form->new;
377 $form->{$self->nr_key()} = $self->order->number;
378 $form->{cusordnumber} = $self->order->cusordnumber;
379 $form->{formname} = $self->type;
380 $form->{type} = $self->type;
381 $form->{language} = '_' . $self->order->language->template_code if $self->order->language;
382 $form->{language_id} = $self->order->language->id if $self->order->language;
383 $form->{format} = 'pdf';
385 $email_form->{subject} = $form->generate_email_subject();
386 $email_form->{attachment_filename} = $form->generate_attachment_filename();
387 $email_form->{message} = $form->generate_email_body();
388 $email_form->{js_send_function} = 'kivi.Order.send_email()';
390 my %files = $self->get_files_for_email_dialog();
391 my $dialog_html = $self->render('common/_send_email_dialog', { output => 0 },
392 email_form => $email_form,
393 show_bcc => $::auth->assert('email_bcc', 'may fail'),
395 is_customer => $self->cv eq 'customer',
399 ->run('kivi.Order.show_email_dialog', $dialog_html)
406 # Todo: handling error messages: flash is not displayed in dialog, but in the main form
407 sub action_send_email {
410 my $errors = $self->save();
412 if (scalar @{ $errors }) {
413 $self->js->run('kivi.Order.close_email_dialog');
414 $self->js->flash('error', $_) foreach @{ $errors };
415 return $self->js->render();
418 $self->js_reset_order_and_item_ids_after_save;
420 my $email_form = delete $::form->{email_form};
421 my %field_names = (to => 'email');
423 $::form->{ $field_names{$_} // $_ } = $email_form->{$_} for keys %{ $email_form };
425 # for Form::cleanup which may be called in Form::send_email
426 $::form->{cwd} = getcwd();
427 $::form->{tmpdir} = $::lx_office_conf{paths}->{userspath};
429 $::form->{$_} = $::form->{print_options}->{$_} for keys %{ $::form->{print_options} };
430 $::form->{media} = 'email';
432 if (($::form->{attachment_policy} // '') !~ m{^(?:old_file|no_file)$}) {
434 my @errors = generate_pdf($self->order, \$pdf, {media => $::form->{media},
435 format => $::form->{print_options}->{format},
436 formname => $::form->{print_options}->{formname},
437 language => $self->order->language,
438 printer_id => $::form->{print_options}->{printer_id},
439 groupitems => $::form->{print_options}->{groupitems}});
440 if (scalar @errors) {
441 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
444 my $sfile = SL::SessionFile::Random->new(mode => "w");
445 $sfile->fh->print($pdf);
448 $::form->{tmpfile} = $sfile->file_name;
449 $::form->{tmpdir} = $sfile->get_path; # for Form::cleanup which may be called in Form::send_email
452 $::form->{id} = $self->order->id; # this is used in SL::Mailer to create a linked record to the mail
453 $::form->send_email(\%::myconfig, 'pdf');
456 my $intnotes = $self->order->intnotes;
457 $intnotes .= "\n\n" if $self->order->intnotes;
458 $intnotes .= t8('[email]') . "\n";
459 $intnotes .= t8('Date') . ": " . $::locale->format_date_object(DateTime->now_local, precision => 'seconds') . "\n";
460 $intnotes .= t8('To (email)') . ": " . $::form->{email} . "\n";
461 $intnotes .= t8('Cc') . ": " . $::form->{cc} . "\n" if $::form->{cc};
462 $intnotes .= t8('Bcc') . ": " . $::form->{bcc} . "\n" if $::form->{bcc};
463 $intnotes .= t8('Subject') . ": " . $::form->{subject} . "\n\n";
464 $intnotes .= t8('Message') . ": " . $::form->{message};
466 $self->order->update_attributes(intnotes => $intnotes);
468 flash_later('info', t8('The email has been sent.'));
470 my @redirect_params = (
473 id => $self->order->id,
476 $self->redirect_to(@redirect_params);
479 # open the periodic invoices config dialog
481 # If there are values in the form (i.e. dialog was opened before),
482 # then use this values. Create new ones, else.
483 sub action_show_periodic_invoices_config_dialog {
486 my $config = make_periodic_invoices_config_from_yaml(delete $::form->{config});
487 $config ||= SL::DB::Manager::PeriodicInvoicesConfig->find_by(oe_id => $::form->{id}) if $::form->{id};
488 $config ||= SL::DB::PeriodicInvoicesConfig->new(periodicity => 'm',
489 order_value_periodicity => 'p', # = same as periodicity
490 start_date_as_date => $::form->{transdate_as_date} || $::form->current_date,
491 extend_automatically_by => 12,
493 email_subject => GenericTranslations->get(
494 language_id => $::form->{language_id},
495 translation_type =>"preset_text_periodic_invoices_email_subject"),
496 email_body => GenericTranslations->get(
497 language_id => $::form->{language_id},
498 translation_type =>"preset_text_periodic_invoices_email_body"),
500 $config->periodicity('m') if none { $_ eq $config->periodicity } @SL::DB::PeriodicInvoicesConfig::PERIODICITIES;
501 $config->order_value_periodicity('p') if none { $_ eq $config->order_value_periodicity } ('p', @SL::DB::PeriodicInvoicesConfig::ORDER_VALUE_PERIODICITIES);
503 $::form->get_lists(printers => "ALL_PRINTERS",
504 charts => { key => 'ALL_CHARTS',
505 transdate => 'current_date' });
507 $::form->{AR} = [ grep { $_->{link} =~ m/(?:^|:)AR(?::|$)/ } @{ $::form->{ALL_CHARTS} } ];
509 if ($::form->{customer_id}) {
510 $::form->{ALL_CONTACTS} = SL::DB::Manager::Contact->get_all_sorted(where => [ cp_cv_id => $::form->{customer_id} ]);
511 $::form->{email_recipient_invoice_address} = SL::DB::Manager::Customer->find_by(id => $::form->{customer_id})->invoice_mail;
514 $self->render('oe/edit_periodic_invoices_config', { layout => 0 },
516 popup_js_close_function => 'kivi.Order.close_periodic_invoices_config_dialog()',
517 popup_js_assign_function => 'kivi.Order.assign_periodic_invoices_config()',
522 # assign the values of the periodic invoices config dialog
523 # as yaml in the hidden tag and set the status.
524 sub action_assign_periodic_invoices_config {
527 $::form->isblank('start_date_as_date', $::locale->text('The start date is missing.'));
529 my $config = { active => $::form->{active} ? 1 : 0,
530 terminated => $::form->{terminated} ? 1 : 0,
531 direct_debit => $::form->{direct_debit} ? 1 : 0,
532 periodicity => (any { $_ eq $::form->{periodicity} } @SL::DB::PeriodicInvoicesConfig::PERIODICITIES) ? $::form->{periodicity} : 'm',
533 order_value_periodicity => (any { $_ eq $::form->{order_value_periodicity} } ('p', @SL::DB::PeriodicInvoicesConfig::ORDER_VALUE_PERIODICITIES)) ? $::form->{order_value_periodicity} : 'p',
534 start_date_as_date => $::form->{start_date_as_date},
535 end_date_as_date => $::form->{end_date_as_date},
536 first_billing_date_as_date => $::form->{first_billing_date_as_date},
537 print => $::form->{print} ? 1 : 0,
538 printer_id => $::form->{print} ? $::form->{printer_id} * 1 : undef,
539 copies => $::form->{copies} * 1 ? $::form->{copies} : 1,
540 extend_automatically_by => $::form->{extend_automatically_by} * 1 || undef,
541 ar_chart_id => $::form->{ar_chart_id} * 1,
542 send_email => $::form->{send_email} ? 1 : 0,
543 email_recipient_contact_id => $::form->{email_recipient_contact_id} * 1 || undef,
544 email_recipient_address => $::form->{email_recipient_address},
545 email_sender => $::form->{email_sender},
546 email_subject => $::form->{email_subject},
547 email_body => $::form->{email_body},
550 my $periodic_invoices_config = SL::YAML::Dump($config);
552 my $status = $self->get_periodic_invoices_status($config);
555 ->remove('#order_periodic_invoices_config')
556 ->insertAfter(hidden_tag('order.periodic_invoices_config', $periodic_invoices_config), '#periodic_invoices_status')
557 ->run('kivi.Order.close_periodic_invoices_config_dialog')
558 ->html('#periodic_invoices_status', $status)
559 ->flash('info', t8('The periodic invoices config has been assigned.'))
563 sub action_get_has_active_periodic_invoices {
566 my $config = make_periodic_invoices_config_from_yaml(delete $::form->{config});
567 $config ||= SL::DB::Manager::PeriodicInvoicesConfig->find_by(oe_id => $::form->{id}) if $::form->{id};
569 my $has_active_periodic_invoices =
570 $self->type eq sales_order_type()
573 && (!$config->end_date || ($config->end_date > DateTime->today_local))
574 && $config->get_previous_billed_period_start_date;
576 $_[0]->render(\ !!$has_active_periodic_invoices, { type => 'text' });
579 # save the order and redirect to the frontend subroutine for a new
581 sub action_save_and_delivery_order {
584 $self->save_and_redirect_to(
585 controller => 'oe.pl',
586 action => 'oe_delivery_order_from_order',
590 # save the order and redirect to the frontend subroutine for a new
592 sub action_save_and_invoice {
595 $self->save_and_redirect_to(
596 controller => 'oe.pl',
597 action => 'oe_invoice_from_order',
601 # workflow from sales quotation to sales order
602 sub action_sales_order {
603 $_[0]->workflow_sales_or_purchase_order();
606 # workflow from rfq to purchase order
607 sub action_purchase_order {
608 $_[0]->workflow_sales_or_purchase_order();
611 # workflow from purchase order to ap transaction
612 sub action_save_and_ap_transaction {
615 $self->save_and_redirect_to(
616 controller => 'ap.pl',
617 action => 'add_from_purchase_order',
621 # set form elements in respect to a changed customer or vendor
623 # This action is called on an change of the customer/vendor picker.
624 sub action_customer_vendor_changed {
627 setup_order_from_cv($self->order);
630 my $cv_method = $self->cv;
632 if ($self->order->$cv_method->contacts && scalar @{ $self->order->$cv_method->contacts } > 0) {
633 $self->js->show('#cp_row');
635 $self->js->hide('#cp_row');
638 if ($self->order->$cv_method->shipto && scalar @{ $self->order->$cv_method->shipto } > 0) {
639 $self->js->show('#shipto_selection');
641 $self->js->hide('#shipto_selection');
644 $self->js->val( '#order_salesman_id', $self->order->salesman_id) if $self->order->is_sales;
647 ->replaceWith('#order_cp_id', $self->build_contact_select)
648 ->replaceWith('#order_shipto_id', $self->build_shipto_select)
649 ->replaceWith('#shipto_inputs ', $self->build_shipto_inputs)
650 ->replaceWith('#business_info_row', $self->build_business_info_row)
651 ->val( '#order_taxzone_id', $self->order->taxzone_id)
652 ->val( '#order_taxincluded', $self->order->taxincluded)
653 ->val( '#order_currency_id', $self->order->currency_id)
654 ->val( '#order_payment_id', $self->order->payment_id)
655 ->val( '#order_delivery_term_id', $self->order->delivery_term_id)
656 ->val( '#order_intnotes', $self->order->intnotes)
657 ->val( '#order_language_id', $self->order->$cv_method->language_id)
658 ->focus( '#order_' . $self->cv . '_id')
659 ->run('kivi.Order.update_exchangerate');
661 $self->js_redisplay_amounts_and_taxes;
662 $self->js_redisplay_cvpartnumbers;
666 # open the dialog for customer/vendor details
667 sub action_show_customer_vendor_details_dialog {
670 my $is_customer = 'customer' eq $::form->{vc};
673 $cv = SL::DB::Customer->new(id => $::form->{vc_id})->load;
675 $cv = SL::DB::Vendor->new(id => $::form->{vc_id})->load;
678 my %details = map { $_ => $cv->$_ } @{$cv->meta->columns};
679 $details{discount_as_percent} = $cv->discount_as_percent;
680 $details{creditlimt} = $cv->creditlimit_as_number;
681 $details{business} = $cv->business->description if $cv->business;
682 $details{language} = $cv->language_obj->description if $cv->language_obj;
683 $details{delivery_terms} = $cv->delivery_term->description if $cv->delivery_term;
684 $details{payment_terms} = $cv->payment->description if $cv->payment;
685 $details{pricegroup} = $cv->pricegroup->pricegroup if $is_customer && $cv->pricegroup;
687 foreach my $entry (@{ $cv->shipto }) {
688 push @{ $details{SHIPTO} }, { map { $_ => $entry->$_ } @{$entry->meta->columns} };
690 foreach my $entry (@{ $cv->contacts }) {
691 push @{ $details{CONTACTS} }, { map { $_ => $entry->$_ } @{$entry->meta->columns} };
694 $_[0]->render('common/show_vc_details', { layout => 0 },
695 is_customer => $is_customer,
700 # called if a unit in an existing item row is changed
701 sub action_unit_changed {
704 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
705 my $item = $self->order->items_sorted->[$idx];
707 my $old_unit_obj = SL::DB::Unit->new(name => $::form->{old_unit})->load;
708 $item->sellprice($item->unit_obj->convert_to($item->sellprice, $old_unit_obj));
713 ->run('kivi.Order.update_sellprice', $::form->{item_id}, $item->sellprice_as_number);
714 $self->js_redisplay_line_values;
715 $self->js_redisplay_amounts_and_taxes;
719 # add an item row for a new item entered in the input row
720 sub action_add_item {
723 my $form_attr = $::form->{add_item};
725 return unless $form_attr->{parts_id};
727 my $item = new_item($self->order, $form_attr);
729 $self->order->add_items($item);
733 $self->get_item_cvpartnumber($item);
735 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
736 my $row_as_html = $self->p->render('order/tabs/_row',
742 if ($::form->{insert_before_item_id}) {
744 ->before ('.row_entry:has(#item_' . $::form->{insert_before_item_id} . ')', $row_as_html);
747 ->append('#row_table_id', $row_as_html);
750 if ( $item->part->is_assortment ) {
751 $form_attr->{qty_as_number} = 1 unless $form_attr->{qty_as_number};
752 foreach my $assortment_item ( @{$item->part->assortment_items} ) {
753 my $attr = { parts_id => $assortment_item->parts_id,
754 qty => $assortment_item->qty * $::form->parse_amount(\%::myconfig, $form_attr->{qty_as_number}), # TODO $form_attr->{unit}
755 unit => $assortment_item->unit,
756 description => $assortment_item->part->description,
758 my $item = new_item($self->order, $attr);
760 # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount
761 $item->discount(1) unless $assortment_item->charge;
763 $self->order->add_items( $item );
765 $self->get_item_cvpartnumber($item);
766 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
767 my $row_as_html = $self->p->render('order/tabs/_row',
772 if ($::form->{insert_before_item_id}) {
774 ->before ('.row_entry:has(#item_' . $::form->{insert_before_item_id} . ')', $row_as_html);
777 ->append('#row_table_id', $row_as_html);
783 ->val('.add_item_input', '')
784 ->run('kivi.Order.init_row_handlers')
785 ->run('kivi.Order.renumber_positions')
786 ->focus('#add_item_parts_id_name');
788 $self->js->run('kivi.Order.row_table_scroll_down') if !$::form->{insert_before_item_id};
790 $self->js_redisplay_amounts_and_taxes;
794 # open the dialog for entering multiple items at once
795 sub action_show_multi_items_dialog {
796 $_[0]->render('order/tabs/_multi_items_dialog', { layout => 0 },
797 all_partsgroups => SL::DB::Manager::PartsGroup->get_all);
800 # update the filter results in the multi item dialog
801 sub action_multi_items_update_result {
804 $::form->{multi_items}->{filter}->{obsolete} = 0;
806 my $count = $_[0]->multi_items_models->count;
809 my $text = SL::Presenter::EscapedText->new(text => $::locale->text('No results.'));
810 $_[0]->render($text, { layout => 0 });
811 } elsif ($count > $max_count) {
812 my $text = SL::Presenter::EscapedText->new(text => $::locale->text('Too many results (#1 from #2).', $count, $max_count));
813 $_[0]->render($text, { layout => 0 });
815 my $multi_items = $_[0]->multi_items_models->get;
816 $_[0]->render('order/tabs/_multi_items_result', { layout => 0 },
817 multi_items => $multi_items);
821 # add item rows for multiple items at once
822 sub action_add_multi_items {
825 my @form_attr = grep { $_->{qty_as_number} } @{ $::form->{add_multi_items} };
826 return $self->js->render() unless scalar @form_attr;
829 foreach my $attr (@form_attr) {
830 my $item = new_item($self->order, $attr);
832 if ( $item->part->is_assortment ) {
833 foreach my $assortment_item ( @{$item->part->assortment_items} ) {
834 my $attr = { parts_id => $assortment_item->parts_id,
835 qty => $assortment_item->qty * $item->qty, # TODO $form_attr->{unit}
836 unit => $assortment_item->unit,
837 description => $assortment_item->part->description,
839 my $item = new_item($self->order, $attr);
841 # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount
842 $item->discount(1) unless $assortment_item->charge;
847 $self->order->add_items(@items);
851 foreach my $item (@items) {
852 $self->get_item_cvpartnumber($item);
853 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
854 my $row_as_html = $self->p->render('order/tabs/_row',
860 if ($::form->{insert_before_item_id}) {
862 ->before ('.row_entry:has(#item_' . $::form->{insert_before_item_id} . ')', $row_as_html);
865 ->append('#row_table_id', $row_as_html);
870 ->run('kivi.Order.close_multi_items_dialog')
871 ->run('kivi.Order.init_row_handlers')
872 ->run('kivi.Order.renumber_positions')
873 ->focus('#add_item_parts_id_name');
875 $self->js->run('kivi.Order.row_table_scroll_down') if !$::form->{insert_before_item_id};
877 $self->js_redisplay_amounts_and_taxes;
881 # recalculate all linetotals, amounts and taxes and redisplay them
882 sub action_recalc_amounts_and_taxes {
887 $self->js_redisplay_line_values;
888 $self->js_redisplay_amounts_and_taxes;
892 sub action_update_exchangerate {
896 is_standard => $self->order->currency_id == $::instance_conf->get_currency_id,
897 currency_name => $self->order->currency->name,
898 exchangerate => $self->order->daily_exchangerate_as_null_number,
901 $self->render(\SL::JSON::to_json($data), { type => 'json', process => 0 });
904 # redisplay item rows if they are sorted by an attribute
905 sub action_reorder_items {
909 partnumber => sub { $_[0]->part->partnumber },
910 description => sub { $_[0]->description },
911 qty => sub { $_[0]->qty },
912 sellprice => sub { $_[0]->sellprice },
913 discount => sub { $_[0]->discount },
914 cvpartnumber => sub { $_[0]->{cvpartnumber} },
917 $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
919 my $method = $sort_keys{$::form->{order_by}};
920 my @to_sort = map { { old_pos => $_->position, order_by => $method->($_) } } @{ $self->order->items_sorted };
921 if ($::form->{sort_dir}) {
922 if ( $::form->{order_by} =~ m/qty|sellprice|discount/ ){
923 @to_sort = sort { $a->{order_by} <=> $b->{order_by} } @to_sort;
925 @to_sort = sort { $a->{order_by} cmp $b->{order_by} } @to_sort;
928 if ( $::form->{order_by} =~ m/qty|sellprice|discount/ ){
929 @to_sort = sort { $b->{order_by} <=> $a->{order_by} } @to_sort;
931 @to_sort = sort { $b->{order_by} cmp $a->{order_by} } @to_sort;
935 ->run('kivi.Order.redisplay_items', \@to_sort)
939 # show the popup to choose a price/discount source
940 sub action_price_popup {
943 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
944 my $item = $self->order->items_sorted->[$idx];
946 $self->render_price_dialog($item);
949 # load the second row for one or more items
951 # This action gets the html code for all items second rows by rendering a template for
952 # the second row and sets the html code via client js.
953 sub action_load_second_rows {
956 $self->recalc() if $self->order->is_sales; # for margin calculation
958 foreach my $item_id (@{ $::form->{item_ids} }) {
959 my $idx = first_index { $_ eq $item_id } @{ $::form->{orderitem_ids} };
960 my $item = $self->order->items_sorted->[$idx];
962 $self->js_load_second_row($item, $item_id, 0);
965 $self->js->run('kivi.Order.init_row_handlers') if $self->order->is_sales; # for lastcosts change-callback
970 # update description, notes and sellprice from master data
971 sub action_update_row_from_master_data {
974 foreach my $item_id (@{ $::form->{item_ids} }) {
975 my $idx = first_index { $_ eq $item_id } @{ $::form->{orderitem_ids} };
976 my $item = $self->order->items_sorted->[$idx];
977 my $texts = get_part_texts($item->part, $self->order->language_id);
979 $item->description($texts->{description});
980 $item->longdescription($texts->{longdescription});
982 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
985 if ($item->part->is_assortment) {
986 # add assortment items with price 0, as the components carry the price
987 $price_src = $price_source->price_from_source("");
988 $price_src->price(0);
990 $price_src = $price_source->best_price
991 ? $price_source->best_price
992 : $price_source->price_from_source("");
993 $price_src->price($::form->round_amount($price_src->price / $self->order->exchangerate, 5)) if $self->order->exchangerate;
994 $price_src->price(0) if !$price_source->best_price;
998 $item->sellprice($price_src->price);
999 $item->active_price_source($price_src);
1002 ->run('kivi.Order.update_sellprice', $item_id, $item->sellprice_as_number)
1003 ->html('.row_entry:has(#item_' . $item_id . ') [name = "partnumber"] a', $item->part->partnumber)
1004 ->val ('.row_entry:has(#item_' . $item_id . ') [name = "order.orderitems[].description"]', $item->description)
1005 ->val ('.row_entry:has(#item_' . $item_id . ') [name = "order.orderitems[].longdescription"]', $item->longdescription);
1007 if ($self->search_cvpartnumber) {
1008 $self->get_item_cvpartnumber($item);
1009 $self->js->html('.row_entry:has(#item_' . $item_id . ') [name = "cvpartnumber"]', $item->{cvpartnumber});
1014 $self->js_redisplay_line_values;
1015 $self->js_redisplay_amounts_and_taxes;
1017 $self->js->render();
1020 sub js_load_second_row {
1021 my ($self, $item, $item_id, $do_parse) = @_;
1024 # Parse values from form (they are formated while rendering (template)).
1025 # Workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
1026 # This parsing is not necessary at all, if we assure that the second row/cvars are only loaded once.
1027 foreach my $var (@{ $item->cvars_by_config }) {
1028 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
1030 $item->parse_custom_variable_values;
1033 my $row_as_html = $self->p->render('order/tabs/_second_row', ITEM => $item, TYPE => $self->type);
1036 ->html('#second_row_' . $item_id, $row_as_html)
1037 ->data('#second_row_' . $item_id, 'loaded', 1);
1040 sub js_redisplay_line_values {
1043 my $is_sales = $self->order->is_sales;
1045 # sales orders with margins
1050 $::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0),
1051 $::form->format_amount(\%::myconfig, $_->{marge_total}, 2, 0),
1052 $::form->format_amount(\%::myconfig, $_->{marge_percent}, 2, 0),
1053 ]} @{ $self->order->items_sorted };
1057 $::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0),
1058 ]} @{ $self->order->items_sorted };
1062 ->run('kivi.Order.redisplay_line_values', $is_sales, \@data);
1065 sub js_redisplay_amounts_and_taxes {
1068 if (scalar @{ $self->{taxes} }) {
1069 $self->js->show('#taxincluded_row_id');
1071 $self->js->hide('#taxincluded_row_id');
1074 if ($self->order->taxincluded) {
1075 $self->js->hide('#subtotal_row_id');
1077 $self->js->show('#subtotal_row_id');
1080 if ($self->order->is_sales) {
1081 my $is_neg = $self->order->marge_total < 0;
1083 ->html('#marge_total_id', $::form->format_amount(\%::myconfig, $self->order->marge_total, 2))
1084 ->html('#marge_percent_id', $::form->format_amount(\%::myconfig, $self->order->marge_percent, 2))
1085 ->action_if( $is_neg, 'addClass', '#marge_total_id', 'plus0')
1086 ->action_if( $is_neg, 'addClass', '#marge_percent_id', 'plus0')
1087 ->action_if( $is_neg, 'addClass', '#marge_percent_sign_id', 'plus0')
1088 ->action_if(!$is_neg, 'removeClass', '#marge_total_id', 'plus0')
1089 ->action_if(!$is_neg, 'removeClass', '#marge_percent_id', 'plus0')
1090 ->action_if(!$is_neg, 'removeClass', '#marge_percent_sign_id', 'plus0');
1094 ->html('#netamount_id', $::form->format_amount(\%::myconfig, $self->order->netamount, -2))
1095 ->html('#amount_id', $::form->format_amount(\%::myconfig, $self->order->amount, -2))
1096 ->remove('.tax_row')
1097 ->insertBefore($self->build_tax_rows, '#amount_row_id');
1100 sub js_redisplay_cvpartnumbers {
1103 $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
1105 my @data = map {[$_->{cvpartnumber}]} @{ $self->order->items_sorted };
1108 ->run('kivi.Order.redisplay_cvpartnumbers', \@data);
1111 sub js_reset_order_and_item_ids_after_save {
1115 ->val('#id', $self->order->id)
1116 ->val('#converted_from_oe_id', '')
1117 ->val('#order_' . $self->nr_key(), $self->order->number);
1120 foreach my $form_item_id (@{ $::form->{orderitem_ids} }) {
1121 next if !$self->order->items_sorted->[$idx]->id;
1122 next if $form_item_id !~ m{^new};
1124 ->val ('[name="orderitem_ids[+]"][value="' . $form_item_id . '"]', $self->order->items_sorted->[$idx]->id)
1125 ->val ('#item_' . $form_item_id, $self->order->items_sorted->[$idx]->id)
1126 ->attr('#item_' . $form_item_id, "id", 'item_' . $self->order->items_sorted->[$idx]->id);
1130 $self->js->val('[name="converted_from_orderitems_ids[+]"]', '');
1137 sub init_valid_types {
1138 [ sales_order_type(), purchase_order_type(), sales_quotation_type(), request_quotation_type() ];
1144 if (none { $::form->{type} eq $_ } @{$self->valid_types}) {
1145 die "Not a valid type for order";
1148 $self->type($::form->{type});
1154 my $cv = (any { $self->type eq $_ } (sales_order_type(), sales_quotation_type())) ? 'customer'
1155 : (any { $self->type eq $_ } (purchase_order_type(), request_quotation_type())) ? 'vendor'
1156 : die "Not a valid type for order";
1161 sub init_search_cvpartnumber {
1164 my $user_prefs = SL::Helper::UserPreferences::PartPickerSearch->new();
1165 my $search_cvpartnumber;
1166 $search_cvpartnumber = !!$user_prefs->get_sales_search_customer_partnumber() if $self->cv eq 'customer';
1167 $search_cvpartnumber = !!$user_prefs->get_purchase_search_makemodel() if $self->cv eq 'vendor';
1169 return $search_cvpartnumber;
1172 sub init_show_update_button {
1175 !!SL::Helper::UserPreferences::UpdatePositions->new()->get_show_update_button();
1186 # model used to filter/display the parts in the multi-items dialog
1187 sub init_multi_items_models {
1188 SL::Controller::Helper::GetModels->new(
1189 controller => $_[0],
1191 with_objects => [ qw(unit_obj) ],
1192 disable_plugin => 'paginated',
1193 source => $::form->{multi_items},
1199 partnumber => t8('Partnumber'),
1200 description => t8('Description')}
1204 sub init_all_price_factors {
1205 SL::DB::Manager::PriceFactor->get_all;
1211 my $right_for = { map { $_ => $_.'_edit' } @{$self->valid_types} };
1213 my $right = $right_for->{ $self->type };
1214 $right ||= 'DOES_NOT_EXIST';
1216 $::auth->assert($right);
1219 # build the selection box for contacts
1221 # Needed, if customer/vendor changed.
1222 sub build_contact_select {
1225 select_tag('order.cp_id', [ $self->order->{$self->cv}->contacts ],
1226 value_key => 'cp_id',
1227 title_key => 'full_name_dep',
1228 default => $self->order->cp_id,
1230 style => 'width: 300px',
1234 # build the selection box for shiptos
1236 # Needed, if customer/vendor changed.
1237 sub build_shipto_select {
1240 select_tag('order.shipto_id',
1241 [ {displayable_id => t8("No/individual shipping address"), shipto_id => ''}, $self->order->{$self->cv}->shipto ],
1242 value_key => 'shipto_id',
1243 title_key => 'displayable_id',
1244 default => $self->order->shipto_id,
1246 style => 'width: 300px',
1250 # build the inputs for the cusom shipto dialog
1252 # Needed, if customer/vendor changed.
1253 sub build_shipto_inputs {
1256 my $content = $self->p->render('common/_ship_to_dialog',
1257 vc_obj => $self->order->customervendor,
1258 cs_obj => $self->order->custom_shipto,
1259 cvars => $self->order->custom_shipto->cvars_by_config,
1260 id_selector => '#order_shipto_id');
1262 div_tag($content, id => 'shipto_inputs');
1265 # render the info line for business
1267 # Needed, if customer/vendor changed.
1268 sub build_business_info_row
1270 $_[0]->p->render('order/tabs/_business_info_row', SELF => $_[0]);
1273 # build the rows for displaying taxes
1275 # Called if amounts where recalculated and redisplayed.
1276 sub build_tax_rows {
1280 foreach my $tax (sort { $a->{tax}->rate cmp $b->{tax}->rate } @{ $self->{taxes} }) {
1281 $rows_as_html .= $self->p->render('order/tabs/_tax_row', TAX => $tax, TAXINCLUDED => $self->order->taxincluded);
1283 return $rows_as_html;
1287 sub render_price_dialog {
1288 my ($self, $record_item) = @_;
1290 my $price_source = SL::PriceSource->new(record_item => $record_item, record => $self->order);
1294 'kivi.io.price_chooser_dialog',
1295 t8('Available Prices'),
1296 $self->render('order/tabs/_price_sources_dialog', { output => 0 }, price_source => $price_source)
1301 # $self->js->text('#dialog_flash_error_content', join ' ', @errors);
1302 # $self->js->show('#dialog_flash_error');
1311 return if !$::form->{id};
1313 $self->order(SL::DB::Order->new(id => $::form->{id})->load);
1315 # Add an empty custom shipto to the order, so that the dialog can render the cvar inputs.
1316 # You need a custom shipto object to call cvars_by_config to get the cvars.
1317 $self->order->custom_shipto(SL::DB::Shipto->new(module => 'OE', custom_variables => [])) if !$self->order->custom_shipto;
1319 return $self->order;
1322 # load or create a new order object
1324 # And assign changes from the form to this object.
1325 # If the order is loaded from db, check if items are deleted in the form,
1326 # remove them form the object and collect them for removing from db on saving.
1327 # Then create/update items from form (via make_item) and add them.
1331 # add_items adds items to an order with no items for saving, but they cannot
1332 # be retrieved via items until the order is saved. Adding empty items to new
1333 # order here solves this problem.
1335 $order = SL::DB::Order->new(id => $::form->{id})->load(with => [ 'orderitems', 'orderitems.part' ]) if $::form->{id};
1336 $order ||= SL::DB::Order->new(orderitems => [],
1337 quotation => (any { $self->type eq $_ } (sales_quotation_type(), request_quotation_type())),
1338 currency_id => $::instance_conf->get_currency_id(),);
1340 my $cv_id_method = $self->cv . '_id';
1341 if (!$::form->{id} && $::form->{$cv_id_method}) {
1342 $order->$cv_id_method($::form->{$cv_id_method});
1343 setup_order_from_cv($order);
1346 my $form_orderitems = delete $::form->{order}->{orderitems};
1347 my $form_periodic_invoices_config = delete $::form->{order}->{periodic_invoices_config};
1349 $order->assign_attributes(%{$::form->{order}});
1351 $self->setup_custom_shipto_from_form($order, $::form);
1353 if (my $periodic_invoices_config_attrs = $form_periodic_invoices_config ? SL::YAML::Load($form_periodic_invoices_config) : undef) {
1354 my $periodic_invoices_config = $order->periodic_invoices_config || $order->periodic_invoices_config(SL::DB::PeriodicInvoicesConfig->new);
1355 $periodic_invoices_config->assign_attributes(%$periodic_invoices_config_attrs);
1358 # remove deleted items
1359 $self->item_ids_to_delete([]);
1360 foreach my $idx (reverse 0..$#{$order->orderitems}) {
1361 my $item = $order->orderitems->[$idx];
1362 if (none { $item->id == $_->{id} } @{$form_orderitems}) {
1363 splice @{$order->orderitems}, $idx, 1;
1364 push @{$self->item_ids_to_delete}, $item->id;
1370 foreach my $form_attr (@{$form_orderitems}) {
1371 my $item = make_item($order, $form_attr);
1372 $item->position($pos);
1376 $order->add_items(grep {!$_->id} @items);
1381 # create or update items from form
1383 # Make item objects from form values. For items already existing read from db.
1384 # Create a new item else. And assign attributes.
1386 my ($record, $attr) = @_;
1389 $item = first { $_->id == $attr->{id} } @{$record->items} if $attr->{id};
1391 my $is_new = !$item;
1393 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
1394 # they cannot be retrieved via custom_variables until the order/orderitem is
1395 # saved. Adding empty custom_variables to new orderitem here solves this problem.
1396 $item ||= SL::DB::OrderItem->new(custom_variables => []);
1398 $item->assign_attributes(%$attr);
1401 my $texts = get_part_texts($item->part, $record->language_id);
1402 $item->longdescription($texts->{longdescription}) if !defined $attr->{longdescription};
1403 $item->project_id($record->globalproject_id) if !defined $attr->{project_id};
1404 $item->lastcost($record->is_sales ? $item->part->lastcost : 0) if !defined $attr->{lastcost_as_number};
1412 # This is used to add one item
1414 my ($record, $attr) = @_;
1416 my $item = SL::DB::OrderItem->new;
1418 # Remove attributes where the user left or set the inputs empty.
1419 # So these attributes will be undefined and we can distinguish them
1420 # from zero later on.
1421 for (qw(qty_as_number sellprice_as_number discount_as_percent)) {
1422 delete $attr->{$_} if $attr->{$_} eq '';
1425 $item->assign_attributes(%$attr);
1427 my $part = SL::DB::Part->new(id => $attr->{parts_id})->load;
1428 my $price_source = SL::PriceSource->new(record_item => $item, record => $record);
1430 $item->unit($part->unit) if !$item->unit;
1433 if ( $part->is_assortment ) {
1434 # add assortment items with price 0, as the components carry the price
1435 $price_src = $price_source->price_from_source("");
1436 $price_src->price(0);
1437 } elsif (defined $item->sellprice) {
1438 $price_src = $price_source->price_from_source("");
1439 $price_src->price($item->sellprice);
1441 $price_src = $price_source->best_price
1442 ? $price_source->best_price
1443 : $price_source->price_from_source("");
1444 $price_src->price($::form->round_amount($price_src->price / $record->exchangerate, 5)) if $record->exchangerate;
1445 $price_src->price(0) if !$price_source->best_price;
1449 if (defined $item->discount) {
1450 $discount_src = $price_source->discount_from_source("");
1451 $discount_src->discount($item->discount);
1453 $discount_src = $price_source->best_discount
1454 ? $price_source->best_discount
1455 : $price_source->discount_from_source("");
1456 $discount_src->discount(0) if !$price_source->best_discount;
1460 $new_attr{part} = $part;
1461 $new_attr{description} = $part->description if ! $item->description;
1462 $new_attr{qty} = 1.0 if ! $item->qty;
1463 $new_attr{price_factor_id} = $part->price_factor_id if ! $item->price_factor_id;
1464 $new_attr{sellprice} = $price_src->price;
1465 $new_attr{discount} = $discount_src->discount;
1466 $new_attr{active_price_source} = $price_src;
1467 $new_attr{active_discount_source} = $discount_src;
1468 $new_attr{longdescription} = $part->notes if ! defined $attr->{longdescription};
1469 $new_attr{project_id} = $record->globalproject_id;
1470 $new_attr{lastcost} = $record->is_sales ? $part->lastcost : 0;
1472 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
1473 # they cannot be retrieved via custom_variables until the order/orderitem is
1474 # saved. Adding empty custom_variables to new orderitem here solves this problem.
1475 $new_attr{custom_variables} = [];
1477 my $texts = get_part_texts($part, $record->language_id, description => $new_attr{description}, longdescription => $new_attr{longdescription});
1479 $item->assign_attributes(%new_attr, %{ $texts });
1484 sub setup_order_from_cv {
1487 $order->$_($order->customervendor->$_) for (qw(taxzone_id payment_id delivery_term_id currency_id));
1489 $order->intnotes($order->customervendor->notes);
1491 if ($order->is_sales) {
1492 $order->salesman_id($order->customer->salesman_id || SL::DB::Manager::Employee->current->id);
1493 $order->taxincluded(defined($order->customer->taxincluded_checked)
1494 ? $order->customer->taxincluded_checked
1495 : $::myconfig{taxincluded_checked});
1500 # setup custom shipto from form
1502 # The dialog returns form variables starting with 'shipto' and cvars starting
1503 # with 'shiptocvar_'.
1504 # Mark it to be deleted if a shipto from master data is selected
1505 # (i.e. order has a shipto).
1506 # Else, update or create a new custom shipto. If the fields are empty, it
1507 # will not be saved on save.
1508 sub setup_custom_shipto_from_form {
1509 my ($self, $order, $form) = @_;
1511 if ($order->shipto) {
1512 $self->is_custom_shipto_to_delete(1);
1514 my $custom_shipto = $order->custom_shipto || $order->custom_shipto(SL::DB::Shipto->new(module => 'OE', custom_variables => []));
1516 my $shipto_cvars = {map { my ($key) = m{^shiptocvar_(.+)}; $key => delete $form->{$_}} grep { m{^shiptocvar_} } keys %$form};
1517 my $shipto_attrs = {map { $_ => delete $form->{$_}} grep { m{^shipto} } keys %$form};
1519 $custom_shipto->assign_attributes(%$shipto_attrs);
1520 $custom_shipto->cvar_by_name($_)->value($shipto_cvars->{$_}) for keys %$shipto_cvars;
1524 # recalculate prices and taxes
1526 # Using the PriceTaxCalculator. Store linetotals in the item objects.
1530 my %pat = $self->order->calculate_prices_and_taxes();
1532 $self->{taxes} = [];
1533 foreach my $tax_id (keys %{ $pat{taxes_by_tax_id} }) {
1534 my $netamount = sum0 map { $pat{amounts}->{$_}->{amount} } grep { $pat{amounts}->{$_}->{tax_id} == $tax_id } keys %{ $pat{amounts} };
1536 push(@{ $self->{taxes} }, { amount => $pat{taxes_by_tax_id}->{$tax_id},
1537 netamount => $netamount,
1538 tax => SL::DB::Tax->new(id => $tax_id)->load });
1540 pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items_sorted}, @{$pat{items}};
1543 # get data for saving, printing, ..., that is not changed in the form
1545 # Only cvars for now.
1546 sub get_unalterable_data {
1549 foreach my $item (@{ $self->order->items }) {
1550 # autovivify all cvars that are not in the form (cvars_by_config can do it).
1551 # workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
1552 foreach my $var (@{ $item->cvars_by_config }) {
1553 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
1555 $item->parse_custom_variable_values;
1561 # And remove related files in the spool directory
1566 my $db = $self->order->db;
1568 $db->with_transaction(
1570 my @spoolfiles = grep { $_ } map { $_->spoolfile } @{ SL::DB::Manager::Status->get_all(where => [ trans_id => $self->order->id ]) };
1571 $self->order->delete;
1572 my $spool = $::lx_office_conf{paths}->{spool};
1573 unlink map { "$spool/$_" } @spoolfiles if $spool;
1576 }) || push(@{$errors}, $db->error);
1583 # And delete items that are deleted in the form.
1588 my $db = $self->order->db;
1590 $db->with_transaction(sub {
1591 # delete custom shipto if it is to be deleted or if it is empty
1592 if ($self->order->custom_shipto && ($self->is_custom_shipto_to_delete || $self->order->custom_shipto->is_empty)) {
1593 $self->order->custom_shipto->delete if $self->order->custom_shipto->shipto_id;
1594 $self->order->custom_shipto(undef);
1597 SL::DB::OrderItem->new(id => $_)->delete for @{$self->item_ids_to_delete || []};
1598 $self->order->save(cascade => 1);
1601 if ($::form->{converted_from_oe_id}) {
1602 my @converted_from_oe_ids = split ' ', $::form->{converted_from_oe_id};
1603 foreach my $converted_from_oe_id (@converted_from_oe_ids) {
1604 my $src = SL::DB::Order->new(id => $converted_from_oe_id)->load;
1605 $src->update_attributes(closed => 1) if $src->type =~ /_quotation$/;
1606 $src->link_to_record($self->order);
1608 if (scalar @{ $::form->{converted_from_orderitems_ids} || [] }) {
1610 foreach (@{ $self->order->items_sorted }) {
1611 my $from_id = $::form->{converted_from_orderitems_ids}->[$idx];
1613 SL::DB::RecordLink->new(from_table => 'orderitems',
1614 from_id => $from_id,
1615 to_table => 'orderitems',
1623 }) || push(@{$errors}, $db->error);
1628 sub workflow_sales_or_purchase_order {
1632 my $errors = $self->save();
1634 if (scalar @{ $errors }) {
1635 $self->js->flash('error', $_) foreach @{ $errors };
1636 return $self->js->render();
1639 my $destination_type = $::form->{type} eq sales_quotation_type() ? sales_order_type()
1640 : $::form->{type} eq request_quotation_type() ? purchase_order_type()
1641 : $::form->{type} eq purchase_order_type() ? sales_order_type()
1642 : $::form->{type} eq sales_order_type() ? purchase_order_type()
1645 # check for direct delivery
1646 # copy shipto in custom shipto (custom shipto will be copied by new_from() in case)
1648 if ( $::form->{type} eq sales_order_type() && $destination_type eq purchase_order_type()
1649 && $::form->{use_shipto} && $self->order->shipto) {
1650 $custom_shipto = $self->order->shipto->clone('SL::DB::Order');
1653 $self->order(SL::DB::Order->new_from($self->order, destination_type => $destination_type));
1654 $self->{converted_from_oe_id} = delete $::form->{id};
1656 # set item ids to new fake id, to identify them as new items
1657 foreach my $item (@{$self->order->items_sorted}) {
1658 $item->{new_fake_id} = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
1661 if ($::form->{type} eq sales_order_type() && $destination_type eq purchase_order_type()) {
1662 if ($::form->{use_shipto}) {
1663 $self->order->custom_shipto($custom_shipto) if $custom_shipto;
1665 # remove any custom shipto if not wanted
1666 $self->order->custom_shipto(SL::DB::Shipto->new(module => 'OE', custom_variables => []));
1671 $::form->{type} = $destination_type;
1672 $self->type($self->init_type);
1673 $self->cv ($self->init_cv);
1677 $self->get_unalterable_data();
1678 $self->pre_render();
1680 # trigger rendering values for second row as hidden, because they
1681 # are loaded only on demand. So we need to keep the values from the
1683 $_->{render_second_row} = 1 for @{ $self->order->items_sorted };
1687 title => $self->get_title_for('edit'),
1688 %{$self->{template_args}}
1696 $self->{all_taxzones} = SL::DB::Manager::TaxZone->get_all_sorted();
1697 $self->{all_currencies} = SL::DB::Manager::Currency->get_all_sorted();
1698 $self->{all_departments} = SL::DB::Manager::Department->get_all_sorted();
1699 $self->{all_languages} = SL::DB::Manager::Language->get_all_sorted();
1700 $self->{all_employees} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->employee_id,
1703 $self->{all_salesmen} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->salesman_id,
1706 $self->{all_payment_terms} = SL::DB::Manager::PaymentTerm->get_all_sorted(where => [ or => [ id => $self->order->payment_id,
1708 $self->{all_delivery_terms} = SL::DB::Manager::DeliveryTerm->get_all_sorted();
1709 $self->{current_employee_id} = SL::DB::Manager::Employee->current->id;
1710 $self->{periodic_invoices_status} = $self->get_periodic_invoices_status($self->order->periodic_invoices_config);
1711 $self->{order_probabilities} = [ map { { title => ($_ * 10) . '%', id => $_ * 10 } } (0..10) ];
1712 $self->{positions_scrollbar_height} = SL::Helper::UserPreferences::PositionsScrollbar->new()->get_height();
1714 my $print_form = Form->new('');
1715 $print_form->{type} = $self->type;
1716 $print_form->{printers} = SL::DB::Manager::Printer->get_all_sorted;
1717 $self->{print_options} = SL::Helper::PrintOptions->get_print_options(
1718 form => $print_form,
1719 options => {dialog_name_prefix => 'print_options.',
1723 no_opendocument => 0,
1727 foreach my $item (@{$self->order->orderitems}) {
1728 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
1729 $item->active_price_source( $price_source->price_from_source( $item->active_price_source ));
1730 $item->active_discount_source($price_source->discount_from_source($item->active_discount_source));
1733 if (any { $self->type eq $_ } (sales_order_type(), purchase_order_type())) {
1734 # calculate shipped qtys here to prevent calling calculate for every item via the items method
1735 SL::Helper::ShippedQty->new->calculate($self->order)->write_to_objects;
1738 if ($self->order->number && $::instance_conf->get_webdav) {
1739 my $webdav = SL::Webdav->new(
1740 type => $self->type,
1741 number => $self->order->number,
1743 my @all_objects = $webdav->get_all_objects;
1744 @{ $self->{template_args}->{WEBDAV} } = map { { name => $_->filename,
1746 link => File::Spec->catfile($_->full_filedescriptor),
1750 $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
1752 $::request->{layout}->use_javascript("${_}.js") for qw(kivi.SalesPurchase kivi.Order kivi.File ckeditor/ckeditor ckeditor/adapters/jquery
1753 edit_periodic_invoices_config calculate_qty kivi.Validator follow_up);
1754 $self->setup_edit_action_bar;
1757 sub setup_edit_action_bar {
1758 my ($self, %params) = @_;
1760 my $deletion_allowed = (any { $self->type eq $_ } (sales_quotation_type(), request_quotation_type()))
1761 || (($self->type eq sales_order_type()) && $::instance_conf->get_sales_order_show_delete)
1762 || (($self->type eq purchase_order_type()) && $::instance_conf->get_purchase_order_show_delete);
1764 for my $bar ($::request->layout->get('actionbar')) {
1769 call => [ 'kivi.Order.save', 'save', $::instance_conf->get_order_warn_duplicate_parts,
1770 $::instance_conf->get_order_warn_no_deliverydate,
1772 checks => [ 'kivi.Order.check_save_active_periodic_invoices', ['kivi.validate_form','#order_form'] ],
1776 call => [ 'kivi.Order.save', 'save_as_new', $::instance_conf->get_order_warn_duplicate_parts ],
1777 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1778 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1780 ], # end of combobox "Save"
1787 t8('Save and Sales Order'),
1788 submit => [ '#order_form', { action => "Order/sales_order" } ],
1789 only_if => (any { $self->type eq $_ } (sales_quotation_type(), purchase_order_type())),
1792 t8('Save and Purchase Order'),
1793 call => [ 'kivi.Order.purchase_order_check_for_direct_delivery' ],
1794 only_if => (any { $self->type eq $_ } (sales_order_type(), request_quotation_type())),
1797 t8('Save and Delivery Order'),
1798 call => [ 'kivi.Order.save', 'save_and_delivery_order', $::instance_conf->get_order_warn_duplicate_parts,
1799 $::instance_conf->get_order_warn_no_deliverydate,
1801 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1802 only_if => (any { $self->type eq $_ } (sales_order_type(), purchase_order_type()))
1805 t8('Save and Invoice'),
1806 call => [ 'kivi.Order.save', 'save_and_invoice', $::instance_conf->get_order_warn_duplicate_parts ],
1807 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1810 t8('Save and AP Transaction'),
1811 call => [ 'kivi.Order.save', 'save_and_ap_transaction', $::instance_conf->get_order_warn_duplicate_parts ],
1812 only_if => (any { $self->type eq $_ } (purchase_order_type()))
1815 ], # end of combobox "Workflow"
1822 t8('Save and print'),
1823 call => [ 'kivi.Order.show_print_options', $::instance_conf->get_order_warn_duplicate_parts ],
1826 t8('Save and E-mail'),
1827 call => [ 'kivi.Order.save', 'save_and_show_email_dialog', $::instance_conf->get_order_warn_duplicate_parts ],
1828 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1831 t8('Download attachments of all parts'),
1832 call => [ 'kivi.File.downloadOrderitemsFiles', $::form->{type}, $::form->{id} ],
1833 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1834 only_if => $::instance_conf->get_doc_storage,
1836 ], # end of combobox "Export"
1840 call => [ 'kivi.Order.delete_order' ],
1841 confirm => $::locale->text('Do you really want to delete this object?'),
1842 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1843 only_if => $deletion_allowed,
1852 call => [ 'kivi.Order.follow_up_window' ],
1853 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1854 only_if => $::auth->assert('productivity', 1),
1856 ], # end of combobox "more"
1862 my ($order, $pdf_ref, $params) = @_;
1866 my $print_form = Form->new('');
1867 $print_form->{type} = $order->type;
1868 $print_form->{formname} = $params->{formname} || $order->type;
1869 $print_form->{format} = $params->{format} || 'pdf';
1870 $print_form->{media} = $params->{media} || 'file';
1871 $print_form->{groupitems} = $params->{groupitems};
1872 $print_form->{printer_id} = $params->{printer_id};
1873 $print_form->{media} = 'file' if $print_form->{media} eq 'screen';
1875 $order->language($params->{language});
1876 $order->flatten_to_form($print_form, format_amounts => 1);
1880 if ($print_form->{format} =~ /(opendocument|oasis)/i) {
1881 $template_ext = 'odt';
1882 $template_type = 'OpenDocument';
1885 # search for the template
1886 my ($template_file, @template_files) = SL::Helper::CreatePDF->find_template(
1887 name => $print_form->{formname},
1888 extension => $template_ext,
1889 email => $print_form->{media} eq 'email',
1890 language => $params->{language},
1891 printer_id => $print_form->{printer_id},
1894 if (!defined $template_file) {
1895 push @errors, $::locale->text('Cannot find matching template for this print request. Please contact your template maintainer. I tried these: #1.', join ', ', map { "'$_'"} @template_files);
1898 return @errors if scalar @errors;
1900 $print_form->throw_on_error(sub {
1902 $print_form->prepare_for_printing;
1904 $$pdf_ref = SL::Helper::CreatePDF->create_pdf(
1905 format => $print_form->{format},
1906 template_type => $template_type,
1907 template => $template_file,
1908 variables => $print_form,
1909 variable_content_types => {
1910 longdescription => 'html',
1911 partnotes => 'html',
1916 } || push @errors, ref($EVAL_ERROR) eq 'SL::X::FormError' ? $EVAL_ERROR->error : $EVAL_ERROR;
1922 sub get_files_for_email_dialog {
1925 my %files = map { ($_ => []) } qw(versions files vc_files part_files);
1927 return %files if !$::instance_conf->get_doc_storage;
1929 if ($self->order->id) {
1930 $files{versions} = [ SL::File->get_all_versions(object_id => $self->order->id, object_type => $self->order->type, file_type => 'document') ];
1931 $files{files} = [ SL::File->get_all( object_id => $self->order->id, object_type => $self->order->type, file_type => 'attachment') ];
1932 $files{vc_files} = [ SL::File->get_all( object_id => $self->order->{$self->cv}->id, object_type => $self->cv, file_type => 'attachment') ];
1936 uniq_by { $_->{id} }
1938 +{ id => $_->part->id,
1939 partnumber => $_->part->partnumber }
1940 } @{$self->order->items_sorted};
1942 foreach my $part (@parts) {
1943 my @pfiles = SL::File->get_all(object_id => $part->{id}, object_type => 'part');
1944 push @{ $files{part_files} }, map { +{ %{ $_ }, partnumber => $part->{partnumber} } } @pfiles;
1947 foreach my $key (keys %files) {
1948 $files{$key} = [ sort_by { lc $_->{db_file}->{file_name} } @{ $files{$key} } ];
1954 sub make_periodic_invoices_config_from_yaml {
1955 my ($yaml_config) = @_;
1957 return if !$yaml_config;
1958 my $attr = SL::YAML::Load($yaml_config);
1959 return if 'HASH' ne ref $attr;
1960 return SL::DB::PeriodicInvoicesConfig->new(%$attr);
1964 sub get_periodic_invoices_status {
1965 my ($self, $config) = @_;
1967 return if $self->type ne sales_order_type();
1968 return t8('not configured') if !$config;
1970 my $active = ('HASH' eq ref $config) ? $config->{active}
1971 : ('SL::DB::PeriodicInvoicesConfig' eq ref $config) ? $config->active
1972 : die "Cannot get status of periodic invoices config";
1974 return $active ? t8('active') : t8('inactive');
1978 my ($self, $action) = @_;
1980 return '' if none { lc($action)} qw(add edit);
1983 # $::locale->text("Add Sales Order");
1984 # $::locale->text("Add Purchase Order");
1985 # $::locale->text("Add Quotation");
1986 # $::locale->text("Add Request for Quotation");
1987 # $::locale->text("Edit Sales Order");
1988 # $::locale->text("Edit Purchase Order");
1989 # $::locale->text("Edit Quotation");
1990 # $::locale->text("Edit Request for Quotation");
1992 $action = ucfirst(lc($action));
1993 return $self->type eq sales_order_type() ? $::locale->text("$action Sales Order")
1994 : $self->type eq purchase_order_type() ? $::locale->text("$action Purchase Order")
1995 : $self->type eq sales_quotation_type() ? $::locale->text("$action Quotation")
1996 : $self->type eq request_quotation_type() ? $::locale->text("$action Request for Quotation")
2000 sub get_item_cvpartnumber {
2001 my ($self, $item) = @_;
2003 return if !$self->search_cvpartnumber;
2004 return if !$self->order->customervendor;
2006 if ($self->cv eq 'vendor') {
2007 my @mms = grep { $_->make eq $self->order->customervendor->id } @{$item->part->makemodels};
2008 $item->{cvpartnumber} = $mms[0]->model if scalar @mms;
2009 } elsif ($self->cv eq 'customer') {
2010 my @cps = grep { $_->customer_id eq $self->order->customervendor->id } @{$item->part->customerprices};
2011 $item->{cvpartnumber} = $cps[0]->customer_partnumber if scalar @cps;
2015 sub get_part_texts {
2016 my ($part_or_id, $language_or_id, %defaults) = @_;
2018 my $part = ref($part_or_id) ? $part_or_id : SL::DB::Part->load_cached($part_or_id);
2019 my $language_id = ref($language_or_id) ? $language_or_id->id : $language_or_id;
2021 description => $defaults{description} // $part->description,
2022 longdescription => $defaults{longdescription} // $part->notes,
2025 return $texts unless $language_id;
2027 my $translation = SL::DB::Manager::Translation->get_first(
2029 parts_id => $part->id,
2030 language_id => $language_id,
2033 $texts->{description} = $translation->translation if $translation && $translation->translation;
2034 $texts->{longdescription} = $translation->longdescription if $translation && $translation->longdescription;
2039 sub sales_order_type {
2043 sub purchase_order_type {
2047 sub sales_quotation_type {
2051 sub request_quotation_type {
2052 'request_quotation';
2056 return $_[0]->type eq sales_order_type() ? 'ordnumber'
2057 : $_[0]->type eq purchase_order_type() ? 'ordnumber'
2058 : $_[0]->type eq sales_quotation_type() ? 'quonumber'
2059 : $_[0]->type eq request_quotation_type() ? 'quonumber'
2063 sub save_and_redirect_to {
2064 my ($self, %params) = @_;
2066 my $errors = $self->save();
2068 if (scalar @{ $errors }) {
2069 $self->js->flash('error', $_) foreach @{ $errors };
2070 return $self->js->render();
2073 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
2074 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
2075 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
2076 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
2078 flash_later('info', $text);
2080 $self->redirect_to(%params, id => $self->order->id);
2091 SL::Controller::Order - controller for orders
2095 This is a new form to enter orders, completely rewritten with the use
2096 of controller and java script techniques.
2098 The aim is to provide the user a better experience and a faster workflow. Also
2099 the code should be more readable, more reliable and better to maintain.
2107 One input row, so that input happens every time at the same place.
2111 Use of pickers where possible.
2115 Possibility to enter more than one item at once.
2119 Item list in a scrollable area, so that the workflow buttons stay at
2124 Reordering item rows with drag and drop is possible. Sorting item rows is
2125 possible (by partnumber, description, qty, sellprice and discount for now).
2129 No C<update> is necessary. All entries and calculations are managed
2130 with ajax-calls and the page only reloads on C<save>.
2134 User can see changes immediately, because of the use of java script
2145 =item * C<SL/Controller/Order.pm>
2149 =item * C<template/webpages/order/form.html>
2153 =item * C<template/webpages/order/tabs/basic_data.html>
2155 Main tab for basic_data.
2157 This is the only tab here for now. "linked records" and "webdav" tabs are
2158 reused from generic code.
2162 =item * C<template/webpages/order/tabs/_business_info_row.html>
2164 For displaying information on business type
2166 =item * C<template/webpages/order/tabs/_item_input.html>
2168 The input line for items
2170 =item * C<template/webpages/order/tabs/_row.html>
2172 One row for already entered items
2174 =item * C<template/webpages/order/tabs/_tax_row.html>
2176 Displaying tax information
2178 =item * C<template/webpages/order/tabs/_multi_items_dialog.html>
2180 Dialog for entering more than one item at once
2182 =item * C<template/webpages/order/tabs/_multi_items_result.html>
2184 Results for the filter in the multi items dialog
2186 =item * C<template/webpages/order/tabs/_price_sources_dialog.html>
2188 Dialog for selecting price and discount sources
2192 =item * C<js/kivi.Order.js>
2194 java script functions
2204 =item * credit limit
2206 =item * more workflows (quotation, rfq)
2208 =item * price sources: little symbols showing better price / better discount
2210 =item * select units in input row?
2212 =item * check for direct delivery (workflow sales order -> purchase order)
2214 =item * access rights
2216 =item * display weights
2222 =item * optional client/user behaviour
2224 (transactions has to be set - department has to be set -
2225 force project if enabled in client config - transport cost reminder)
2229 =head1 KNOWN BUGS AND CAVEATS
2235 Customer discount is not displayed as a valid discount in price source popup
2236 (this might be a bug in price sources)
2238 (I cannot reproduce this (Bernd))
2242 No indication that <shift>-up/down expands/collapses second row.
2246 Inline creation of parts is not currently supported
2250 Table header is not sticky in the scrolling area.
2254 Sorting does not include C<position>, neither does reordering.
2256 This behavior was implemented intentionally. But we can discuss, which behavior
2257 should be implemented.
2261 C<show_multi_items_dialog> does not use the currently inserted string for
2266 =head1 To discuss / Nice to have
2272 How to expand/collapse second row. Now it can be done clicking the icon or
2277 Possibility to select PriceSources in input row?
2281 This controller uses a (changed) copy of the template for the PriceSource
2282 dialog. Maybe there could be used one code source.
2286 Rounding-differences between this controller (PriceTaxCalculator) and the old
2287 form. This is not only a problem here, but also in all parts using the PTC.
2288 There exists a ticket and a patch. This patch should be testet.
2292 An indicator, if the actual inputs are saved (like in an
2293 editor or on text processing application).
2297 A warning when leaving the page without saveing unchanged inputs.
2304 Bernd Bleßmann E<lt>bernd@kivitendo-premium.deE<gt>