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);
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::Helper::CreatePDF qw(:all);
26 use SL::Helper::PrintOptions;
27 use SL::Helper::ShippedQty;
28 use SL::Helper::UserPreferences::PositionsScrollbar;
29 use SL::Helper::UserPreferences::UpdatePositions;
31 use SL::Controller::Helper::GetModels;
33 use List::Util qw(first sum0);
34 use List::UtilsBy qw(sort_by uniq_by);
35 use List::MoreUtils qw(any none pairwise first_index);
36 use English qw(-no_match_vars);
41 use Rose::Object::MakeMethods::Generic
43 scalar => [ qw(item_ids_to_delete) ],
44 'scalar --get_set_init' => [ qw(order valid_types type cv p multi_items_models all_price_factors search_cvpartnumber show_update_button) ],
49 __PACKAGE__->run_before('check_auth');
51 __PACKAGE__->run_before('recalc',
52 only => [ qw(save save_as_new save_and_delivery_order save_and_invoice save_and_ap_transaction
55 __PACKAGE__->run_before('get_unalterable_data',
56 only => [ qw(save save_as_new save_and_delivery_order save_and_invoice save_and_ap_transaction
67 $self->order->transdate(DateTime->now_local());
68 my $extra_days = $self->{type} eq 'sales_quotation' ? $::instance_conf->get_reqdate_interval :
69 $self->{type} eq 'sales_order' ? $::instance_conf->get_delivery_date_interval : 1;
70 $self->order->reqdate(DateTime->today_local->next_workday(extra_days => $extra_days)) if !$self->order->reqdate;
76 title => $self->get_title_for('add'),
77 %{$self->{template_args}}
81 # edit an existing order
89 # this is to edit an order from an unsaved order object
91 # set item ids to new fake id, to identify them as new items
92 foreach my $item (@{$self->order->items_sorted}) {
93 $item->{new_fake_id} = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
95 # trigger rendering values for second row/longdescription as hidden,
96 # because they are loaded only on demand. So we need to keep the values
98 $_->{render_second_row} = 1 for @{ $self->order->items_sorted };
99 $_->{render_longdescription} = 1 for @{ $self->order->items_sorted };
106 title => $self->get_title_for('edit'),
107 %{$self->{template_args}}
111 # edit a collective order (consisting of one or more existing orders)
112 sub action_edit_collective {
116 my @multi_ids = map {
117 $_ =~ m{^multi_id_(\d+)$} && $::form->{'multi_id_' . $1} && $::form->{'trans_id_' . $1} && $::form->{'trans_id_' . $1}
118 } grep { $_ =~ m{^multi_id_\d+$} } keys %$::form;
120 # fall back to add if no ids are given
121 if (scalar @multi_ids == 0) {
126 # fall back to save as new if only one id is given
127 if (scalar @multi_ids == 1) {
128 $self->order(SL::DB::Order->new(id => $multi_ids[0])->load);
129 $self->action_save_as_new();
133 # make new order from given orders
134 my @multi_orders = map { SL::DB::Order->new(id => $_)->load } @multi_ids;
135 $self->{converted_from_oe_id} = join ' ', map { $_->id } @multi_orders;
136 $self->order(SL::DB::Order->new_from_multi(\@multi_orders, sort_sources_by => 'transdate'));
138 $self->action_edit();
145 my $errors = $self->delete();
147 if (scalar @{ $errors }) {
148 $self->js->flash('error', $_) foreach @{ $errors };
149 return $self->js->render();
152 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been deleted')
153 : $self->type eq purchase_order_type() ? $::locale->text('The order has been deleted')
154 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been deleted')
155 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been deleted')
157 flash_later('info', $text);
159 my @redirect_params = (
164 $self->redirect_to(@redirect_params);
171 my $errors = $self->save();
173 if (scalar @{ $errors }) {
174 $self->js->flash('error', $_) foreach @{ $errors };
175 return $self->js->render();
178 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
179 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
180 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
181 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
183 flash_later('info', $text);
185 my @redirect_params = (
188 id => $self->order->id,
191 $self->redirect_to(@redirect_params);
194 # save the order as new document an open it for edit
195 sub action_save_as_new {
198 my $order = $self->order;
201 $self->js->flash('error', t8('This object has not been saved yet.'));
202 return $self->js->render();
205 # load order from db to check if values changed
206 my $saved_order = SL::DB::Order->new(id => $order->id)->load;
209 # Lets assign a new number if the user hasn't changed the previous one.
210 # If it has been changed manually then use it as-is.
211 $new_attrs{number} = (trim($order->number) eq $saved_order->number)
213 : trim($order->number);
215 # Clear transdate unless changed
216 $new_attrs{transdate} = ($order->transdate == $saved_order->transdate)
217 ? DateTime->today_local
220 # Set new reqdate unless changed
221 if ($order->reqdate == $saved_order->reqdate) {
222 my $extra_days = $self->{type} eq 'sales_quotation' ? $::instance_conf->get_reqdate_interval :
223 $self->{type} eq 'sales_order' ? $::instance_conf->get_delivery_date_interval : 1;
224 $new_attrs{reqdate} = DateTime->today_local->next_workday(extra_days => $extra_days);
226 $new_attrs{reqdate} = $order->reqdate;
230 $new_attrs{employee} = SL::DB::Manager::Employee->current;
232 # Create new record from current one
233 $self->order(SL::DB::Order->new_from($order, destination_type => $order->type, attributes => \%new_attrs));
235 # no linked records on save as new
236 delete $::form->{$_} for qw(converted_from_oe_id converted_from_orderitems_ids);
239 $self->action_save();
244 # This is called if "print" is pressed in the print dialog.
245 # If PDF creation was requested and succeeded, the pdf is offered for download
246 # via send_file (which uses ajax in this case).
250 my $errors = $self->save();
252 if (scalar @{ $errors }) {
253 $self->js->flash('error', $_) foreach @{ $errors };
254 return $self->js->render();
257 $self->js_reset_order_and_item_ids_after_save;
259 my $format = $::form->{print_options}->{format};
260 my $media = $::form->{print_options}->{media};
261 my $formname = $::form->{print_options}->{formname};
262 my $copies = $::form->{print_options}->{copies};
263 my $groupitems = $::form->{print_options}->{groupitems};
265 # only pdf and opendocument by now
266 if (none { $format eq $_ } qw(pdf opendocument opendocument_pdf)) {
267 return $self->js->flash('error', t8('Format \'#1\' is not supported yet/anymore.', $format))->render;
270 # only screen or printer by now
271 if (none { $media eq $_ } qw(screen printer)) {
272 return $self->js->flash('error', t8('Media \'#1\' is not supported yet/anymore.', $media))->render;
276 $language = SL::DB::Language->new(id => $::form->{print_options}->{language_id})->load if $::form->{print_options}->{language_id};
278 # create a form for generate_attachment_filename
279 my $form = Form->new;
280 $form->{$self->nr_key()} = $self->order->number;
281 $form->{type} = $self->type;
282 $form->{format} = $format;
283 $form->{formname} = $formname;
284 $form->{language} = '_' . $language->template_code if $language;
285 my $pdf_filename = $form->generate_attachment_filename();
288 my @errors = generate_pdf($self->order, \$pdf, { format => $format,
289 formname => $formname,
290 language => $language,
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_show_email_dialog {
355 my $cv_method = $self->cv;
357 if (!$self->order->$cv_method) {
358 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'))
363 $email_form->{to} = $self->order->contact->cp_email if $self->order->contact;
364 $email_form->{to} ||= $self->order->$cv_method->email;
365 $email_form->{cc} = $self->order->$cv_method->cc;
366 $email_form->{bcc} = join ', ', grep $_, $self->order->$cv_method->bcc, SL::DB::Default->get->global_bcc;
367 # Todo: get addresses from shipto, if any
369 my $form = Form->new;
370 $form->{$self->nr_key()} = $self->order->number;
371 $form->{formname} = $self->type;
372 $form->{type} = $self->type;
373 $form->{language} = '_' . $self->order->language->template_code if $self->order->language;
374 $form->{language_id} = $self->order->language->id if $self->order->language;
375 $form->{format} = 'pdf';
377 $email_form->{subject} = $form->generate_email_subject();
378 $email_form->{attachment_filename} = $form->generate_attachment_filename();
379 $email_form->{message} = $form->generate_email_body();
380 $email_form->{js_send_function} = 'kivi.Order.send_email()';
382 my %files = $self->get_files_for_email_dialog();
383 my $dialog_html = $self->render('common/_send_email_dialog', { output => 0 },
384 email_form => $email_form,
385 show_bcc => $::auth->assert('email_bcc', 'may fail'),
387 is_customer => $self->cv eq 'customer',
391 ->run('kivi.Order.show_email_dialog', $dialog_html)
398 # Todo: handling error messages: flash is not displayed in dialog, but in the main form
399 sub action_send_email {
402 my $errors = $self->save();
404 if (scalar @{ $errors }) {
405 $self->js->run('kivi.Order.close_email_dialog');
406 $self->js->flash('error', $_) foreach @{ $errors };
407 return $self->js->render();
410 $self->js_reset_order_and_item_ids_after_save;
412 my $email_form = delete $::form->{email_form};
413 my %field_names = (to => 'email');
415 $::form->{ $field_names{$_} // $_ } = $email_form->{$_} for keys %{ $email_form };
417 # for Form::cleanup which may be called in Form::send_email
418 $::form->{cwd} = getcwd();
419 $::form->{tmpdir} = $::lx_office_conf{paths}->{userspath};
421 $::form->{$_} = $::form->{print_options}->{$_} for keys %{ $::form->{print_options} };
422 $::form->{media} = 'email';
424 if (($::form->{attachment_policy} // '') !~ m{^(?:old_file|no_file)$}) {
426 $language = SL::DB::Language->new(id => $::form->{print_options}->{language_id})->load if $::form->{print_options}->{language_id};
429 my @errors = generate_pdf($self->order, \$pdf, {media => $::form->{media},
430 format => $::form->{print_options}->{format},
431 formname => $::form->{print_options}->{formname},
432 language => $language,
433 groupitems => $::form->{print_options}->{groupitems}});
434 if (scalar @errors) {
435 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
438 my $sfile = SL::SessionFile::Random->new(mode => "w");
439 $sfile->fh->print($pdf);
442 $::form->{tmpfile} = $sfile->file_name;
443 $::form->{tmpdir} = $sfile->get_path; # for Form::cleanup which may be called in Form::send_email
446 $::form->send_email(\%::myconfig, 'pdf');
449 my $intnotes = $self->order->intnotes;
450 $intnotes .= "\n\n" if $self->order->intnotes;
451 $intnotes .= t8('[email]') . "\n";
452 $intnotes .= t8('Date') . ": " . $::locale->format_date_object(DateTime->now_local, precision => 'seconds') . "\n";
453 $intnotes .= t8('To (email)') . ": " . $::form->{email} . "\n";
454 $intnotes .= t8('Cc') . ": " . $::form->{cc} . "\n" if $::form->{cc};
455 $intnotes .= t8('Bcc') . ": " . $::form->{bcc} . "\n" if $::form->{bcc};
456 $intnotes .= t8('Subject') . ": " . $::form->{subject} . "\n\n";
457 $intnotes .= t8('Message') . ": " . $::form->{message};
459 $self->order->update_attributes(intnotes => $intnotes);
462 ->val('#order_intnotes', $intnotes)
463 ->run('kivi.Order.close_email_dialog')
464 ->flash('info', t8('The email has been sent.'))
468 # open the periodic invoices config dialog
470 # If there are values in the form (i.e. dialog was opened before),
471 # then use this values. Create new ones, else.
472 sub action_show_periodic_invoices_config_dialog {
475 my $config = make_periodic_invoices_config_from_yaml(delete $::form->{config});
476 $config ||= SL::DB::Manager::PeriodicInvoicesConfig->find_by(oe_id => $::form->{id}) if $::form->{id};
477 $config ||= SL::DB::PeriodicInvoicesConfig->new(periodicity => 'm',
478 order_value_periodicity => 'p', # = same as periodicity
479 start_date_as_date => $::form->{transdate_as_date} || $::form->current_date,
480 extend_automatically_by => 12,
482 email_subject => GenericTranslations->get(
483 language_id => $::form->{language_id},
484 translation_type =>"preset_text_periodic_invoices_email_subject"),
485 email_body => GenericTranslations->get(
486 language_id => $::form->{language_id},
487 translation_type =>"preset_text_periodic_invoices_email_body"),
489 $config->periodicity('m') if none { $_ eq $config->periodicity } @SL::DB::PeriodicInvoicesConfig::PERIODICITIES;
490 $config->order_value_periodicity('p') if none { $_ eq $config->order_value_periodicity } ('p', @SL::DB::PeriodicInvoicesConfig::ORDER_VALUE_PERIODICITIES);
492 $::form->get_lists(printers => "ALL_PRINTERS",
493 charts => { key => 'ALL_CHARTS',
494 transdate => 'current_date' });
496 $::form->{AR} = [ grep { $_->{link} =~ m/(?:^|:)AR(?::|$)/ } @{ $::form->{ALL_CHARTS} } ];
498 if ($::form->{customer_id}) {
499 $::form->{ALL_CONTACTS} = SL::DB::Manager::Contact->get_all_sorted(where => [ cp_cv_id => $::form->{customer_id} ]);
500 $::form->{email_recipient_invoice_address} = SL::DB::Manager::Customer->find_by(id => $::form->{customer_id})->invoice_mail;
503 $self->render('oe/edit_periodic_invoices_config', { layout => 0 },
505 popup_js_close_function => 'kivi.Order.close_periodic_invoices_config_dialog()',
506 popup_js_assign_function => 'kivi.Order.assign_periodic_invoices_config()',
511 # assign the values of the periodic invoices config dialog
512 # as yaml in the hidden tag and set the status.
513 sub action_assign_periodic_invoices_config {
516 $::form->isblank('start_date_as_date', $::locale->text('The start date is missing.'));
518 my $config = { active => $::form->{active} ? 1 : 0,
519 terminated => $::form->{terminated} ? 1 : 0,
520 direct_debit => $::form->{direct_debit} ? 1 : 0,
521 periodicity => (any { $_ eq $::form->{periodicity} } @SL::DB::PeriodicInvoicesConfig::PERIODICITIES) ? $::form->{periodicity} : 'm',
522 order_value_periodicity => (any { $_ eq $::form->{order_value_periodicity} } ('p', @SL::DB::PeriodicInvoicesConfig::ORDER_VALUE_PERIODICITIES)) ? $::form->{order_value_periodicity} : 'p',
523 start_date_as_date => $::form->{start_date_as_date},
524 end_date_as_date => $::form->{end_date_as_date},
525 first_billing_date_as_date => $::form->{first_billing_date_as_date},
526 print => $::form->{print} ? 1 : 0,
527 printer_id => $::form->{print} ? $::form->{printer_id} * 1 : undef,
528 copies => $::form->{copies} * 1 ? $::form->{copies} : 1,
529 extend_automatically_by => $::form->{extend_automatically_by} * 1 || undef,
530 ar_chart_id => $::form->{ar_chart_id} * 1,
531 send_email => $::form->{send_email} ? 1 : 0,
532 email_recipient_contact_id => $::form->{email_recipient_contact_id} * 1 || undef,
533 email_recipient_address => $::form->{email_recipient_address},
534 email_sender => $::form->{email_sender},
535 email_subject => $::form->{email_subject},
536 email_body => $::form->{email_body},
539 my $periodic_invoices_config = SL::YAML::Dump($config);
541 my $status = $self->get_periodic_invoices_status($config);
544 ->remove('#order_periodic_invoices_config')
545 ->insertAfter(hidden_tag('order.periodic_invoices_config', $periodic_invoices_config), '#periodic_invoices_status')
546 ->run('kivi.Order.close_periodic_invoices_config_dialog')
547 ->html('#periodic_invoices_status', $status)
548 ->flash('info', t8('The periodic invoices config has been assigned.'))
552 sub action_get_has_active_periodic_invoices {
555 my $config = make_periodic_invoices_config_from_yaml(delete $::form->{config});
556 $config ||= SL::DB::Manager::PeriodicInvoicesConfig->find_by(oe_id => $::form->{id}) if $::form->{id};
558 my $has_active_periodic_invoices =
559 $self->type eq sales_order_type()
562 && (!$config->end_date || ($config->end_date > DateTime->today_local))
563 && $config->get_previous_billed_period_start_date;
565 $_[0]->render(\ !!$has_active_periodic_invoices, { type => 'text' });
568 # save the order and redirect to the frontend subroutine for a new
570 sub action_save_and_delivery_order {
573 my $errors = $self->save();
575 if (scalar @{ $errors }) {
576 $self->js->flash('error', $_) foreach @{ $errors };
577 return $self->js->render();
580 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
581 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
582 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
583 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
585 flash_later('info', $text);
587 my @redirect_params = (
588 controller => 'oe.pl',
589 action => 'oe_delivery_order_from_order',
590 id => $self->order->id,
593 $self->redirect_to(@redirect_params);
596 # save the order and redirect to the frontend subroutine for a new
598 sub action_save_and_invoice {
601 my $errors = $self->save();
603 if (scalar @{ $errors }) {
604 $self->js->flash('error', $_) foreach @{ $errors };
605 return $self->js->render();
608 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
609 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
610 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
611 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
613 flash_later('info', $text);
615 my @redirect_params = (
616 controller => 'oe.pl',
617 action => 'oe_invoice_from_order',
618 id => $self->order->id,
621 $self->redirect_to(@redirect_params);
624 # workflow from sales quotation to sales order
625 sub action_sales_order {
626 $_[0]->workflow_sales_or_purchase_order();
629 # workflow from rfq to purchase order
630 sub action_purchase_order {
631 $_[0]->workflow_sales_or_purchase_order();
634 # workflow from purchase order to ap transaction
635 sub action_save_and_ap_transaction {
638 my $errors = $self->save();
640 if (scalar @{ $errors }) {
641 $self->js->flash('error', $_) foreach @{ $errors };
642 return $self->js->render();
645 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
646 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
647 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
648 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
650 flash_later('info', $text);
652 my @redirect_params = (
653 controller => 'ap.pl',
654 action => 'add_from_purchase_order',
655 id => $self->order->id,
658 $self->redirect_to(@redirect_params);
661 # set form elements in respect to a changed customer or vendor
663 # This action is called on an change of the customer/vendor picker.
664 sub action_customer_vendor_changed {
667 setup_order_from_cv($self->order);
670 my $cv_method = $self->cv;
672 if ($self->order->$cv_method->contacts && scalar @{ $self->order->$cv_method->contacts } > 0) {
673 $self->js->show('#cp_row');
675 $self->js->hide('#cp_row');
678 if ($self->order->$cv_method->shipto && scalar @{ $self->order->$cv_method->shipto } > 0) {
679 $self->js->show('#shipto_row');
681 $self->js->hide('#shipto_row');
684 $self->js->val( '#order_salesman_id', $self->order->salesman_id) if $self->order->is_sales;
687 ->replaceWith('#order_cp_id', $self->build_contact_select)
688 ->replaceWith('#order_shipto_id', $self->build_shipto_select)
689 ->replaceWith('#business_info_row', $self->build_business_info_row)
690 ->val( '#order_taxzone_id', $self->order->taxzone_id)
691 ->val( '#order_taxincluded', $self->order->taxincluded)
692 ->val( '#order_currency_id', $self->order->currency_id)
693 ->val( '#order_payment_id', $self->order->payment_id)
694 ->val( '#order_delivery_term_id', $self->order->delivery_term_id)
695 ->val( '#order_intnotes', $self->order->intnotes)
696 ->val( '#language_id', $self->order->$cv_method->language_id)
697 ->focus( '#order_' . $self->cv . '_id')
698 ->run('kivi.Order.update_exchangerate');
700 $self->js_redisplay_amounts_and_taxes;
701 $self->js_redisplay_cvpartnumbers;
705 # open the dialog for customer/vendor details
706 sub action_show_customer_vendor_details_dialog {
709 my $is_customer = 'customer' eq $::form->{vc};
712 $cv = SL::DB::Customer->new(id => $::form->{vc_id})->load;
714 $cv = SL::DB::Vendor->new(id => $::form->{vc_id})->load;
717 my %details = map { $_ => $cv->$_ } @{$cv->meta->columns};
718 $details{discount_as_percent} = $cv->discount_as_percent;
719 $details{creditlimt} = $cv->creditlimit_as_number;
720 $details{business} = $cv->business->description if $cv->business;
721 $details{language} = $cv->language_obj->description if $cv->language_obj;
722 $details{delivery_terms} = $cv->delivery_term->description if $cv->delivery_term;
723 $details{payment_terms} = $cv->payment->description if $cv->payment;
724 $details{pricegroup} = $cv->pricegroup->pricegroup if $is_customer && $cv->pricegroup;
726 foreach my $entry (@{ $cv->shipto }) {
727 push @{ $details{SHIPTO} }, { map { $_ => $entry->$_ } @{$entry->meta->columns} };
729 foreach my $entry (@{ $cv->contacts }) {
730 push @{ $details{CONTACTS} }, { map { $_ => $entry->$_ } @{$entry->meta->columns} };
733 $_[0]->render('common/show_vc_details', { layout => 0 },
734 is_customer => $is_customer,
739 # called if a unit in an existing item row is changed
740 sub action_unit_changed {
743 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
744 my $item = $self->order->items_sorted->[$idx];
746 my $old_unit_obj = SL::DB::Unit->new(name => $::form->{old_unit})->load;
747 $item->sellprice($item->unit_obj->convert_to($item->sellprice, $old_unit_obj));
752 ->run('kivi.Order.update_sellprice', $::form->{item_id}, $item->sellprice_as_number);
753 $self->js_redisplay_line_values;
754 $self->js_redisplay_amounts_and_taxes;
758 # add an item row for a new item entered in the input row
759 sub action_add_item {
762 my $form_attr = $::form->{add_item};
764 return unless $form_attr->{parts_id};
766 my $item = new_item($self->order, $form_attr);
768 $self->order->add_items($item);
772 $self->get_item_cvpartnumber($item);
774 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
775 my $row_as_html = $self->p->render('order/tabs/_row',
781 if ($::form->{insert_before_item_id}) {
783 ->before ('.row_entry:has(#item_' . $::form->{insert_before_item_id} . ')', $row_as_html);
786 ->append('#row_table_id', $row_as_html);
789 if ( $item->part->is_assortment ) {
790 $form_attr->{qty_as_number} = 1 unless $form_attr->{qty_as_number};
791 foreach my $assortment_item ( @{$item->part->assortment_items} ) {
792 my $attr = { parts_id => $assortment_item->parts_id,
793 qty => $assortment_item->qty * $::form->parse_amount(\%::myconfig, $form_attr->{qty_as_number}), # TODO $form_attr->{unit}
794 unit => $assortment_item->unit,
795 description => $assortment_item->part->description,
797 my $item = new_item($self->order, $attr);
799 # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount
800 $item->discount(1) unless $assortment_item->charge;
802 $self->order->add_items( $item );
804 $self->get_item_cvpartnumber($item);
805 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
806 my $row_as_html = $self->p->render('order/tabs/_row',
811 if ($::form->{insert_before_item_id}) {
813 ->before ('.row_entry:has(#item_' . $::form->{insert_before_item_id} . ')', $row_as_html);
816 ->append('#row_table_id', $row_as_html);
822 ->val('.add_item_input', '')
823 ->run('kivi.Order.init_row_handlers')
824 ->run('kivi.Order.renumber_positions')
825 ->focus('#add_item_parts_id_name');
827 $self->js->run('kivi.Order.row_table_scroll_down') if !$::form->{insert_before_item_id};
829 $self->js_redisplay_amounts_and_taxes;
833 # open the dialog for entering multiple items at once
834 sub action_show_multi_items_dialog {
835 $_[0]->render('order/tabs/_multi_items_dialog', { layout => 0 },
836 all_partsgroups => SL::DB::Manager::PartsGroup->get_all);
839 # update the filter results in the multi item dialog
840 sub action_multi_items_update_result {
843 $::form->{multi_items}->{filter}->{obsolete} = 0;
845 my $count = $_[0]->multi_items_models->count;
848 my $text = SL::Presenter::EscapedText->new(text => $::locale->text('No results.'));
849 $_[0]->render($text, { layout => 0 });
850 } elsif ($count > $max_count) {
851 my $text = SL::Presenter::EscapedText->new(text => $::locale->text('Too many results (#1 from #2).', $count, $max_count));
852 $_[0]->render($text, { layout => 0 });
854 my $multi_items = $_[0]->multi_items_models->get;
855 $_[0]->render('order/tabs/_multi_items_result', { layout => 0 },
856 multi_items => $multi_items);
860 # add item rows for multiple items at once
861 sub action_add_multi_items {
864 my @form_attr = grep { $_->{qty_as_number} } @{ $::form->{add_multi_items} };
865 return $self->js->render() unless scalar @form_attr;
868 foreach my $attr (@form_attr) {
869 my $item = new_item($self->order, $attr);
871 if ( $item->part->is_assortment ) {
872 foreach my $assortment_item ( @{$item->part->assortment_items} ) {
873 my $attr = { parts_id => $assortment_item->parts_id,
874 qty => $assortment_item->qty * $item->qty, # TODO $form_attr->{unit}
875 unit => $assortment_item->unit,
876 description => $assortment_item->part->description,
878 my $item = new_item($self->order, $attr);
880 # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount
881 $item->discount(1) unless $assortment_item->charge;
886 $self->order->add_items(@items);
890 foreach my $item (@items) {
891 $self->get_item_cvpartnumber($item);
892 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
893 my $row_as_html = $self->p->render('order/tabs/_row',
899 if ($::form->{insert_before_item_id}) {
901 ->before ('.row_entry:has(#item_' . $::form->{insert_before_item_id} . ')', $row_as_html);
904 ->append('#row_table_id', $row_as_html);
909 ->run('kivi.Order.close_multi_items_dialog')
910 ->run('kivi.Order.init_row_handlers')
911 ->run('kivi.Order.renumber_positions')
912 ->focus('#add_item_parts_id_name');
914 $self->js->run('kivi.Order.row_table_scroll_down') if !$::form->{insert_before_item_id};
916 $self->js_redisplay_amounts_and_taxes;
920 # recalculate all linetotals, amounts and taxes and redisplay them
921 sub action_recalc_amounts_and_taxes {
926 $self->js_redisplay_line_values;
927 $self->js_redisplay_amounts_and_taxes;
931 sub action_update_exchangerate {
935 is_standard => $self->order->currency_id == $::instance_conf->get_currency_id,
936 currency_name => $self->order->currency->name,
937 exchangerate => $self->order->daily_exchangerate_as_null_number,
940 $self->render(\SL::JSON::to_json($data), { type => 'json', process => 0 });
943 # redisplay item rows if they are sorted by an attribute
944 sub action_reorder_items {
948 partnumber => sub { $_[0]->part->partnumber },
949 description => sub { $_[0]->description },
950 qty => sub { $_[0]->qty },
951 sellprice => sub { $_[0]->sellprice },
952 discount => sub { $_[0]->discount },
953 cvpartnumber => sub { $_[0]->{cvpartnumber} },
956 $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
958 my $method = $sort_keys{$::form->{order_by}};
959 my @to_sort = map { { old_pos => $_->position, order_by => $method->($_) } } @{ $self->order->items_sorted };
960 if ($::form->{sort_dir}) {
961 if ( $::form->{order_by} =~ m/qty|sellprice|discount/ ){
962 @to_sort = sort { $a->{order_by} <=> $b->{order_by} } @to_sort;
964 @to_sort = sort { $a->{order_by} cmp $b->{order_by} } @to_sort;
967 if ( $::form->{order_by} =~ m/qty|sellprice|discount/ ){
968 @to_sort = sort { $b->{order_by} <=> $a->{order_by} } @to_sort;
970 @to_sort = sort { $b->{order_by} cmp $a->{order_by} } @to_sort;
974 ->run('kivi.Order.redisplay_items', \@to_sort)
978 # show the popup to choose a price/discount source
979 sub action_price_popup {
982 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
983 my $item = $self->order->items_sorted->[$idx];
985 $self->render_price_dialog($item);
988 # get the longdescription for an item if the dialog to enter/change the
989 # longdescription was opened and the longdescription is empty
991 # If this item is new, get the longdescription from Part.
992 # Otherwise get it from OrderItem.
993 sub action_get_item_longdescription {
996 if ($::form->{item_id}) {
997 $longdescription = SL::DB::OrderItem->new(id => $::form->{item_id})->load->longdescription;
998 } elsif ($::form->{parts_id}) {
999 $longdescription = SL::DB::Part->new(id => $::form->{parts_id})->load->notes;
1001 $_[0]->render(\ $longdescription, { type => 'text' });
1004 # load the second row for one or more items
1006 # This action gets the html code for all items second rows by rendering a template for
1007 # the second row and sets the html code via client js.
1008 sub action_load_second_rows {
1011 $self->recalc() if $self->order->is_sales; # for margin calculation
1013 foreach my $item_id (@{ $::form->{item_ids} }) {
1014 my $idx = first_index { $_ eq $item_id } @{ $::form->{orderitem_ids} };
1015 my $item = $self->order->items_sorted->[$idx];
1017 $self->js_load_second_row($item, $item_id, 0);
1020 $self->js->run('kivi.Order.init_row_handlers') if $self->order->is_sales; # for lastcosts change-callback
1022 $self->js->render();
1025 # update description, notes and sellprice from master data
1026 sub action_update_row_from_master_data {
1029 foreach my $item_id (@{ $::form->{item_ids} }) {
1030 my $idx = first_index { $_ eq $item_id } @{ $::form->{orderitem_ids} };
1031 my $item = $self->order->items_sorted->[$idx];
1033 $item->description($item->part->description);
1034 $item->longdescription($item->part->notes);
1036 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
1039 if ($item->part->is_assortment) {
1040 # add assortment items with price 0, as the components carry the price
1041 $price_src = $price_source->price_from_source("");
1042 $price_src->price(0);
1044 $price_src = $price_source->best_price
1045 ? $price_source->best_price
1046 : $price_source->price_from_source("");
1047 $price_src->price(0) if !$price_source->best_price;
1050 $item->sellprice($price_src->price);
1051 $item->active_price_source($price_src);
1054 ->run('kivi.Order.update_sellprice', $item_id, $item->sellprice_as_number)
1055 ->html('.row_entry:has(#item_' . $item_id . ') [name = "partnumber"] a', $item->part->partnumber)
1056 ->val ('.row_entry:has(#item_' . $item_id . ') [name = "order.orderitems[].description"]', $item->description)
1057 ->val ('.row_entry:has(#item_' . $item_id . ') [name = "order.orderitems[].longdescription"]', $item->longdescription);
1059 if ($self->search_cvpartnumber) {
1060 $self->get_item_cvpartnumber($item);
1061 $self->js->html('.row_entry:has(#item_' . $item_id . ') [name = "cvpartnumber"]', $item->{cvpartnumber});
1066 $self->js_redisplay_line_values;
1067 $self->js_redisplay_amounts_and_taxes;
1069 $self->js->render();
1072 sub js_load_second_row {
1073 my ($self, $item, $item_id, $do_parse) = @_;
1076 # Parse values from form (they are formated while rendering (template)).
1077 # Workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
1078 # This parsing is not necessary at all, if we assure that the second row/cvars are only loaded once.
1079 foreach my $var (@{ $item->cvars_by_config }) {
1080 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
1082 $item->parse_custom_variable_values;
1085 my $row_as_html = $self->p->render('order/tabs/_second_row', ITEM => $item, TYPE => $self->type);
1088 ->html('#second_row_' . $item_id, $row_as_html)
1089 ->data('#second_row_' . $item_id, 'loaded', 1);
1092 sub js_redisplay_line_values {
1095 my $is_sales = $self->order->is_sales;
1097 # sales orders with margins
1102 $::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0),
1103 $::form->format_amount(\%::myconfig, $_->{marge_total}, 2, 0),
1104 $::form->format_amount(\%::myconfig, $_->{marge_percent}, 2, 0),
1105 ]} @{ $self->order->items_sorted };
1109 $::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0),
1110 ]} @{ $self->order->items_sorted };
1114 ->run('kivi.Order.redisplay_line_values', $is_sales, \@data);
1117 sub js_redisplay_amounts_and_taxes {
1120 if (scalar @{ $self->{taxes} }) {
1121 $self->js->show('#taxincluded_row_id');
1123 $self->js->hide('#taxincluded_row_id');
1126 if ($self->order->taxincluded) {
1127 $self->js->hide('#subtotal_row_id');
1129 $self->js->show('#subtotal_row_id');
1132 if ($self->order->is_sales) {
1133 my $is_neg = $self->order->marge_total < 0;
1135 ->html('#marge_total_id', $::form->format_amount(\%::myconfig, $self->order->marge_total, 2))
1136 ->html('#marge_percent_id', $::form->format_amount(\%::myconfig, $self->order->marge_percent, 2))
1137 ->action_if( $is_neg, 'addClass', '#marge_total_id', 'plus0')
1138 ->action_if( $is_neg, 'addClass', '#marge_percent_id', 'plus0')
1139 ->action_if( $is_neg, 'addClass', '#marge_percent_sign_id', 'plus0')
1140 ->action_if(!$is_neg, 'removeClass', '#marge_total_id', 'plus0')
1141 ->action_if(!$is_neg, 'removeClass', '#marge_percent_id', 'plus0')
1142 ->action_if(!$is_neg, 'removeClass', '#marge_percent_sign_id', 'plus0');
1146 ->html('#netamount_id', $::form->format_amount(\%::myconfig, $self->order->netamount, -2))
1147 ->html('#amount_id', $::form->format_amount(\%::myconfig, $self->order->amount, -2))
1148 ->remove('.tax_row')
1149 ->insertBefore($self->build_tax_rows, '#amount_row_id');
1152 sub js_redisplay_cvpartnumbers {
1155 $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
1157 my @data = map {[$_->{cvpartnumber}]} @{ $self->order->items_sorted };
1160 ->run('kivi.Order.redisplay_cvpartnumbers', \@data);
1163 sub js_reset_order_and_item_ids_after_save {
1167 ->val('#id', $self->order->id)
1168 ->val('#converted_from_oe_id', '')
1169 ->val('#order_' . $self->nr_key(), $self->order->number);
1172 foreach my $form_item_id (@{ $::form->{orderitem_ids} }) {
1173 next if !$self->order->items_sorted->[$idx]->id;
1174 next if $form_item_id !~ m{^new};
1176 ->val ('[name="orderitem_ids[+]"][value="' . $form_item_id . '"]', $self->order->items_sorted->[$idx]->id)
1177 ->val ('#item_' . $form_item_id, $self->order->items_sorted->[$idx]->id)
1178 ->attr('#item_' . $form_item_id, "id", 'item_' . $self->order->items_sorted->[$idx]->id);
1182 $self->js->val('[name="converted_from_orderitems_ids[+]"]', '');
1189 sub init_valid_types {
1190 [ sales_order_type(), purchase_order_type(), sales_quotation_type(), request_quotation_type() ];
1196 if (none { $::form->{type} eq $_ } @{$self->valid_types}) {
1197 die "Not a valid type for order";
1200 $self->type($::form->{type});
1206 my $cv = (any { $self->type eq $_ } (sales_order_type(), sales_quotation_type())) ? 'customer'
1207 : (any { $self->type eq $_ } (purchase_order_type(), request_quotation_type())) ? 'vendor'
1208 : die "Not a valid type for order";
1213 sub init_search_cvpartnumber {
1216 my $user_prefs = SL::Helper::UserPreferences::PartPickerSearch->new();
1217 my $search_cvpartnumber;
1218 $search_cvpartnumber = !!$user_prefs->get_sales_search_customer_partnumber() if $self->cv eq 'customer';
1219 $search_cvpartnumber = !!$user_prefs->get_purchase_search_makemodel() if $self->cv eq 'vendor';
1221 return $search_cvpartnumber;
1224 sub init_show_update_button {
1227 !!SL::Helper::UserPreferences::UpdatePositions->new()->get_show_update_button();
1238 # model used to filter/display the parts in the multi-items dialog
1239 sub init_multi_items_models {
1240 SL::Controller::Helper::GetModels->new(
1241 controller => $_[0],
1243 with_objects => [ qw(unit_obj) ],
1244 disable_plugin => 'paginated',
1245 source => $::form->{multi_items},
1251 partnumber => t8('Partnumber'),
1252 description => t8('Description')}
1256 sub init_all_price_factors {
1257 SL::DB::Manager::PriceFactor->get_all;
1263 my $right_for = { map { $_ => $_.'_edit' } @{$self->valid_types} };
1265 my $right = $right_for->{ $self->type };
1266 $right ||= 'DOES_NOT_EXIST';
1268 $::auth->assert($right);
1271 # build the selection box for contacts
1273 # Needed, if customer/vendor changed.
1274 sub build_contact_select {
1277 select_tag('order.cp_id', [ $self->order->{$self->cv}->contacts ],
1278 value_key => 'cp_id',
1279 title_key => 'full_name_dep',
1280 default => $self->order->cp_id,
1282 style => 'width: 300px',
1286 # build the selection box for shiptos
1288 # Needed, if customer/vendor changed.
1289 sub build_shipto_select {
1292 select_tag('order.shipto_id', [ $self->order->{$self->cv}->shipto ],
1293 value_key => 'shipto_id',
1294 title_key => 'displayable_id',
1295 default => $self->order->shipto_id,
1297 style => 'width: 300px',
1301 # render the info line for business
1303 # Needed, if customer/vendor changed.
1304 sub build_business_info_row
1306 $_[0]->p->render('order/tabs/_business_info_row', SELF => $_[0]);
1309 # build the rows for displaying taxes
1311 # Called if amounts where recalculated and redisplayed.
1312 sub build_tax_rows {
1316 foreach my $tax (sort { $a->{tax}->rate cmp $b->{tax}->rate } @{ $self->{taxes} }) {
1317 $rows_as_html .= $self->p->render('order/tabs/_tax_row', TAX => $tax, TAXINCLUDED => $self->order->taxincluded);
1319 return $rows_as_html;
1323 sub render_price_dialog {
1324 my ($self, $record_item) = @_;
1326 my $price_source = SL::PriceSource->new(record_item => $record_item, record => $self->order);
1330 'kivi.io.price_chooser_dialog',
1331 t8('Available Prices'),
1332 $self->render('order/tabs/_price_sources_dialog', { output => 0 }, price_source => $price_source)
1337 # $self->js->text('#dialog_flash_error_content', join ' ', @errors);
1338 # $self->js->show('#dialog_flash_error');
1347 return if !$::form->{id};
1349 $self->order(SL::DB::Order->new(id => $::form->{id})->load);
1352 # load or create a new order object
1354 # And assign changes from the form to this object.
1355 # If the order is loaded from db, check if items are deleted in the form,
1356 # remove them form the object and collect them for removing from db on saving.
1357 # Then create/update items from form (via make_item) and add them.
1361 # add_items adds items to an order with no items for saving, but they cannot
1362 # be retrieved via items until the order is saved. Adding empty items to new
1363 # order here solves this problem.
1365 $order = SL::DB::Order->new(id => $::form->{id})->load(with => [ 'orderitems', 'orderitems.part' ]) if $::form->{id};
1366 $order ||= SL::DB::Order->new(orderitems => [],
1367 quotation => (any { $self->type eq $_ } (sales_quotation_type(), request_quotation_type())),
1368 currency_id => $::instance_conf->get_currency_id());
1370 my $cv_id_method = $self->cv . '_id';
1371 if (!$::form->{id} && $::form->{$cv_id_method}) {
1372 $order->$cv_id_method($::form->{$cv_id_method});
1373 setup_order_from_cv($order);
1376 my $form_orderitems = delete $::form->{order}->{orderitems};
1377 my $form_periodic_invoices_config = delete $::form->{order}->{periodic_invoices_config};
1379 $order->assign_attributes(%{$::form->{order}});
1381 if (my $periodic_invoices_config_attrs = $form_periodic_invoices_config ? SL::YAML::Load($form_periodic_invoices_config) : undef) {
1382 my $periodic_invoices_config = $order->periodic_invoices_config || $order->periodic_invoices_config(SL::DB::PeriodicInvoicesConfig->new);
1383 $periodic_invoices_config->assign_attributes(%$periodic_invoices_config_attrs);
1386 # remove deleted items
1387 $self->item_ids_to_delete([]);
1388 foreach my $idx (reverse 0..$#{$order->orderitems}) {
1389 my $item = $order->orderitems->[$idx];
1390 if (none { $item->id == $_->{id} } @{$form_orderitems}) {
1391 splice @{$order->orderitems}, $idx, 1;
1392 push @{$self->item_ids_to_delete}, $item->id;
1398 foreach my $form_attr (@{$form_orderitems}) {
1399 my $item = make_item($order, $form_attr);
1400 $item->position($pos);
1404 $order->add_items(grep {!$_->id} @items);
1409 # create or update items from form
1411 # Make item objects from form values. For items already existing read from db.
1412 # Create a new item else. And assign attributes.
1414 my ($record, $attr) = @_;
1417 $item = first { $_->id == $attr->{id} } @{$record->items} if $attr->{id};
1419 my $is_new = !$item;
1421 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
1422 # they cannot be retrieved via custom_variables until the order/orderitem is
1423 # saved. Adding empty custom_variables to new orderitem here solves this problem.
1424 $item ||= SL::DB::OrderItem->new(custom_variables => []);
1426 $item->assign_attributes(%$attr);
1427 $item->longdescription($item->part->notes) if $is_new && !defined $attr->{longdescription};
1428 $item->project_id($record->globalproject_id) if $is_new && !defined $attr->{project_id};
1429 $item->lastcost($record->is_sales ? $item->part->lastcost : 0) if $is_new && !defined $attr->{lastcost_as_number};
1436 # This is used to add one item
1438 my ($record, $attr) = @_;
1440 my $item = SL::DB::OrderItem->new;
1442 # Remove attributes where the user left or set the inputs empty.
1443 # So these attributes will be undefined and we can distinguish them
1444 # from zero later on.
1445 for (qw(qty_as_number sellprice_as_number discount_as_percent)) {
1446 delete $attr->{$_} if $attr->{$_} eq '';
1449 $item->assign_attributes(%$attr);
1451 my $part = SL::DB::Part->new(id => $attr->{parts_id})->load;
1452 my $price_source = SL::PriceSource->new(record_item => $item, record => $record);
1454 $item->unit($part->unit) if !$item->unit;
1457 if ( $part->is_assortment ) {
1458 # add assortment items with price 0, as the components carry the price
1459 $price_src = $price_source->price_from_source("");
1460 $price_src->price(0);
1461 } elsif (defined $item->sellprice) {
1462 $price_src = $price_source->price_from_source("");
1463 $price_src->price($item->sellprice);
1465 $price_src = $price_source->best_price
1466 ? $price_source->best_price
1467 : $price_source->price_from_source("");
1468 $price_src->price(0) if !$price_source->best_price;
1472 if (defined $item->discount) {
1473 $discount_src = $price_source->discount_from_source("");
1474 $discount_src->discount($item->discount);
1476 $discount_src = $price_source->best_discount
1477 ? $price_source->best_discount
1478 : $price_source->discount_from_source("");
1479 $discount_src->discount(0) if !$price_source->best_discount;
1483 $new_attr{part} = $part;
1484 $new_attr{description} = $part->description if ! $item->description;
1485 $new_attr{qty} = 1.0 if ! $item->qty;
1486 $new_attr{price_factor_id} = $part->price_factor_id if ! $item->price_factor_id;
1487 $new_attr{sellprice} = $price_src->price;
1488 $new_attr{discount} = $discount_src->discount;
1489 $new_attr{active_price_source} = $price_src;
1490 $new_attr{active_discount_source} = $discount_src;
1491 $new_attr{longdescription} = $part->notes if ! defined $attr->{longdescription};
1492 $new_attr{project_id} = $record->globalproject_id;
1493 $new_attr{lastcost} = $record->is_sales ? $part->lastcost : 0;
1495 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
1496 # they cannot be retrieved via custom_variables until the order/orderitem is
1497 # saved. Adding empty custom_variables to new orderitem here solves this problem.
1498 $new_attr{custom_variables} = [];
1500 $item->assign_attributes(%new_attr);
1505 sub setup_order_from_cv {
1508 $order->$_($order->customervendor->$_) for (qw(taxzone_id payment_id delivery_term_id currency_id));
1510 $order->intnotes($order->customervendor->notes);
1512 if ($order->is_sales) {
1513 $order->salesman_id($order->customer->salesman_id || SL::DB::Manager::Employee->current->id);
1514 $order->taxincluded(defined($order->customer->taxincluded_checked)
1515 ? $order->customer->taxincluded_checked
1516 : $::myconfig{taxincluded_checked});
1521 # recalculate prices and taxes
1523 # Using the PriceTaxCalculator. Store linetotals in the item objects.
1527 my %pat = $self->order->calculate_prices_and_taxes();
1529 $self->{taxes} = [];
1530 foreach my $tax_id (keys %{ $pat{taxes_by_tax_id} }) {
1531 my $netamount = sum0 map { $pat{amounts}->{$_}->{amount} } grep { $pat{amounts}->{$_}->{tax_id} == $tax_id } keys %{ $pat{amounts} };
1533 push(@{ $self->{taxes} }, { amount => $pat{taxes_by_tax_id}->{$tax_id},
1534 netamount => $netamount,
1535 tax => SL::DB::Tax->new(id => $tax_id)->load });
1537 pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items_sorted}, @{$pat{items}};
1540 # get data for saving, printing, ..., that is not changed in the form
1542 # Only cvars for now.
1543 sub get_unalterable_data {
1546 foreach my $item (@{ $self->order->items }) {
1547 # autovivify all cvars that are not in the form (cvars_by_config can do it).
1548 # workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
1549 foreach my $var (@{ $item->cvars_by_config }) {
1550 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
1552 $item->parse_custom_variable_values;
1558 # And remove related files in the spool directory
1563 my $db = $self->order->db;
1565 $db->with_transaction(
1567 my @spoolfiles = grep { $_ } map { $_->spoolfile } @{ SL::DB::Manager::Status->get_all(where => [ trans_id => $self->order->id ]) };
1568 $self->order->delete;
1569 my $spool = $::lx_office_conf{paths}->{spool};
1570 unlink map { "$spool/$_" } @spoolfiles if $spool;
1573 }) || push(@{$errors}, $db->error);
1580 # And delete items that are deleted in the form.
1585 my $db = $self->order->db;
1587 $db->with_transaction(sub {
1588 SL::DB::OrderItem->new(id => $_)->delete for @{$self->item_ids_to_delete || []};
1589 $self->order->save(cascade => 1);
1592 if ($::form->{converted_from_oe_id}) {
1593 my @converted_from_oe_ids = split ' ', $::form->{converted_from_oe_id};
1594 foreach my $converted_from_oe_id (@converted_from_oe_ids) {
1595 my $src = SL::DB::Order->new(id => $converted_from_oe_id)->load;
1596 $src->update_attributes(closed => 1) if $src->type =~ /_quotation$/;
1597 $src->link_to_record($self->order);
1599 if (scalar @{ $::form->{converted_from_orderitems_ids} || [] }) {
1601 foreach (@{ $self->order->items_sorted }) {
1602 my $from_id = $::form->{converted_from_orderitems_ids}->[$idx];
1604 SL::DB::RecordLink->new(from_table => 'orderitems',
1605 from_id => $from_id,
1606 to_table => 'orderitems',
1614 }) || push(@{$errors}, $db->error);
1619 sub workflow_sales_or_purchase_order {
1623 my $errors = $self->save();
1625 if (scalar @{ $errors }) {
1626 $self->js->flash('error', $_) foreach @{ $errors };
1627 return $self->js->render();
1630 my $destination_type = $::form->{type} eq sales_quotation_type() ? sales_order_type()
1631 : $::form->{type} eq request_quotation_type() ? purchase_order_type()
1632 : $::form->{type} eq purchase_order_type() ? sales_order_type()
1633 : $::form->{type} eq sales_order_type() ? purchase_order_type()
1636 $self->order(SL::DB::Order->new_from($self->order, destination_type => $destination_type));
1637 $self->{converted_from_oe_id} = delete $::form->{id};
1639 # set item ids to new fake id, to identify them as new items
1640 foreach my $item (@{$self->order->items_sorted}) {
1641 $item->{new_fake_id} = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
1645 $::form->{type} = $destination_type;
1646 $self->type($self->init_type);
1647 $self->cv ($self->init_cv);
1651 $self->get_unalterable_data();
1652 $self->pre_render();
1654 # trigger rendering values for second row/longdescription as hidden,
1655 # because they are loaded only on demand. So we need to keep the values
1657 $_->{render_second_row} = 1 for @{ $self->order->items_sorted };
1658 $_->{render_longdescription} = 1 for @{ $self->order->items_sorted };
1662 title => $self->get_title_for('edit'),
1663 %{$self->{template_args}}
1671 $self->{all_taxzones} = SL::DB::Manager::TaxZone->get_all_sorted();
1672 $self->{all_currencies} = SL::DB::Manager::Currency->get_all_sorted();
1673 $self->{all_departments} = SL::DB::Manager::Department->get_all_sorted();
1674 $self->{all_employees} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->employee_id,
1677 $self->{all_salesmen} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->salesman_id,
1680 $self->{all_payment_terms} = SL::DB::Manager::PaymentTerm->get_all_sorted(where => [ or => [ id => $self->order->payment_id,
1682 $self->{all_delivery_terms} = SL::DB::Manager::DeliveryTerm->get_all_sorted();
1683 $self->{current_employee_id} = SL::DB::Manager::Employee->current->id;
1684 $self->{periodic_invoices_status} = $self->get_periodic_invoices_status($self->order->periodic_invoices_config);
1685 $self->{order_probabilities} = [ map { { title => ($_ * 10) . '%', id => $_ * 10 } } (0..10) ];
1686 $self->{positions_scrollbar_height} = SL::Helper::UserPreferences::PositionsScrollbar->new()->get_height();
1688 my $print_form = Form->new('');
1689 $print_form->{type} = $self->type;
1690 $print_form->{printers} = SL::DB::Manager::Printer->get_all_sorted;
1691 $print_form->{languages} = SL::DB::Manager::Language->get_all_sorted;
1692 $print_form->{language_id} = $self->order->language_id;
1693 $self->{print_options} = SL::Helper::PrintOptions->get_print_options(
1694 form => $print_form,
1695 options => {dialog_name_prefix => 'print_options.',
1699 no_opendocument => 0,
1703 foreach my $item (@{$self->order->orderitems}) {
1704 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
1705 $item->active_price_source( $price_source->price_from_source( $item->active_price_source ));
1706 $item->active_discount_source($price_source->discount_from_source($item->active_discount_source));
1709 if (any { $self->type eq $_ } (sales_order_type(), purchase_order_type())) {
1710 # calculate shipped qtys here to prevent calling calculate for every item via the items method
1711 SL::Helper::ShippedQty->new->calculate($self->order)->write_to_objects;
1714 if ($self->order->number && $::instance_conf->get_webdav) {
1715 my $webdav = SL::Webdav->new(
1716 type => $self->type,
1717 number => $self->order->number,
1719 my @all_objects = $webdav->get_all_objects;
1720 @{ $self->{template_args}->{WEBDAV} } = map { { name => $_->filename,
1722 link => File::Spec->catfile($_->full_filedescriptor),
1726 $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
1728 $::request->{layout}->use_javascript("${_}.js") for qw(kivi.SalesPurchase kivi.Order kivi.File ckeditor/ckeditor ckeditor/adapters/jquery edit_periodic_invoices_config calculate_qty);
1729 $self->setup_edit_action_bar;
1732 sub setup_edit_action_bar {
1733 my ($self, %params) = @_;
1735 my $deletion_allowed = (any { $self->type eq $_ } (sales_quotation_type(), request_quotation_type()))
1736 || (($self->type eq sales_order_type()) && $::instance_conf->get_sales_order_show_delete)
1737 || (($self->type eq purchase_order_type()) && $::instance_conf->get_purchase_order_show_delete);
1739 for my $bar ($::request->layout->get('actionbar')) {
1744 call => [ 'kivi.Order.save', 'save', $::instance_conf->get_order_warn_duplicate_parts,
1745 $::instance_conf->get_order_warn_no_deliverydate,
1747 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1751 call => [ 'kivi.Order.save', 'save_as_new', $::instance_conf->get_order_warn_duplicate_parts ],
1752 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1753 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1755 ], # end of combobox "Save"
1762 t8('Save and Sales Order'),
1763 submit => [ '#order_form', { action => "Order/sales_order" } ],
1764 only_if => (any { $self->type eq $_ } (sales_quotation_type(), purchase_order_type())),
1765 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1768 t8('Save and Purchase Order'),
1769 submit => [ '#order_form', { action => "Order/purchase_order" } ],
1770 only_if => (any { $self->type eq $_ } (sales_order_type(), request_quotation_type())),
1771 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1774 t8('Save and Delivery Order'),
1775 call => [ 'kivi.Order.save', 'save_and_delivery_order', $::instance_conf->get_order_warn_duplicate_parts,
1776 $::instance_conf->get_order_warn_no_deliverydate,
1778 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1779 only_if => (any { $self->type eq $_ } (sales_order_type(), purchase_order_type()))
1782 t8('Save and Invoice'),
1783 call => [ 'kivi.Order.save', 'save_and_invoice', $::instance_conf->get_order_warn_duplicate_parts ],
1784 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1787 t8('Save and AP Transaction'),
1788 call => [ 'kivi.Order.save', 'save_and_ap_transaction', $::instance_conf->get_order_warn_duplicate_parts ],
1789 only_if => (any { $self->type eq $_ } (purchase_order_type()))
1792 ], # end of combobox "Workflow"
1799 t8('Save and print'),
1800 call => [ 'kivi.Order.show_print_options', $::instance_conf->get_order_warn_duplicate_parts ],
1803 t8('Save and E-mail'),
1804 call => [ 'kivi.Order.email', $::instance_conf->get_order_warn_duplicate_parts ],
1807 t8('Download attachments of all parts'),
1808 call => [ 'kivi.File.downloadOrderitemsFiles', $::form->{type}, $::form->{id} ],
1809 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1810 only_if => $::instance_conf->get_doc_storage,
1812 ], # end of combobox "Export"
1816 call => [ 'kivi.Order.delete_order' ],
1817 confirm => $::locale->text('Do you really want to delete this object?'),
1818 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1819 only_if => $deletion_allowed,
1826 my ($order, $pdf_ref, $params) = @_;
1830 my $print_form = Form->new('');
1831 $print_form->{type} = $order->type;
1832 $print_form->{formname} = $params->{formname} || $order->type;
1833 $print_form->{format} = $params->{format} || 'pdf';
1834 $print_form->{media} = $params->{media} || 'file';
1835 $print_form->{groupitems} = $params->{groupitems};
1836 $print_form->{media} = 'file' if $print_form->{media} eq 'screen';
1838 $order->language($params->{language});
1839 $order->flatten_to_form($print_form, format_amounts => 1);
1843 if ($print_form->{format} =~ /(opendocument|oasis)/i) {
1844 $template_ext = 'odt';
1845 $template_type = 'OpenDocument';
1848 # search for the template
1849 my ($template_file, @template_files) = SL::Helper::CreatePDF->find_template(
1850 name => $print_form->{formname},
1851 extension => $template_ext,
1852 email => $print_form->{media} eq 'email',
1853 language => $params->{language},
1854 printer_id => $print_form->{printer_id}, # todo
1857 if (!defined $template_file) {
1858 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);
1861 return @errors if scalar @errors;
1863 $print_form->throw_on_error(sub {
1865 $print_form->prepare_for_printing;
1867 $$pdf_ref = SL::Helper::CreatePDF->create_pdf(
1868 format => $print_form->{format},
1869 template_type => $template_type,
1870 template => $template_file,
1871 variables => $print_form,
1872 variable_content_types => {
1873 longdescription => 'html',
1874 partnotes => 'html',
1879 } || push @errors, ref($EVAL_ERROR) eq 'SL::X::FormError' ? $EVAL_ERROR->error : $EVAL_ERROR;
1885 sub get_files_for_email_dialog {
1888 my %files = map { ($_ => []) } qw(versions files vc_files part_files);
1890 return %files if !$::instance_conf->get_doc_storage;
1892 if ($self->order->id) {
1893 $files{versions} = [ SL::File->get_all_versions(object_id => $self->order->id, object_type => $self->order->type, file_type => 'document') ];
1894 $files{files} = [ SL::File->get_all( object_id => $self->order->id, object_type => $self->order->type, file_type => 'attachment') ];
1895 $files{vc_files} = [ SL::File->get_all( object_id => $self->order->{$self->cv}->id, object_type => $self->cv, file_type => 'attachment') ];
1899 uniq_by { $_->{id} }
1901 +{ id => $_->part->id,
1902 partnumber => $_->part->partnumber }
1903 } @{$self->order->items_sorted};
1905 foreach my $part (@parts) {
1906 my @pfiles = SL::File->get_all(object_id => $part->{id}, object_type => 'part');
1907 push @{ $files{part_files} }, map { +{ %{ $_ }, partnumber => $part->{partnumber} } } @pfiles;
1910 foreach my $key (keys %files) {
1911 $files{$key} = [ sort_by { lc $_->{db_file}->{file_name} } @{ $files{$key} } ];
1917 sub make_periodic_invoices_config_from_yaml {
1918 my ($yaml_config) = @_;
1920 return if !$yaml_config;
1921 my $attr = SL::YAML::Load($yaml_config);
1922 return if 'HASH' ne ref $attr;
1923 return SL::DB::PeriodicInvoicesConfig->new(%$attr);
1927 sub get_periodic_invoices_status {
1928 my ($self, $config) = @_;
1930 return if $self->type ne sales_order_type();
1931 return t8('not configured') if !$config;
1933 my $active = ('HASH' eq ref $config) ? $config->{active}
1934 : ('SL::DB::PeriodicInvoicesConfig' eq ref $config) ? $config->active
1935 : die "Cannot get status of periodic invoices config";
1937 return $active ? t8('active') : t8('inactive');
1941 my ($self, $action) = @_;
1943 return '' if none { lc($action)} qw(add edit);
1946 # $::locale->text("Add Sales Order");
1947 # $::locale->text("Add Purchase Order");
1948 # $::locale->text("Add Quotation");
1949 # $::locale->text("Add Request for Quotation");
1950 # $::locale->text("Edit Sales Order");
1951 # $::locale->text("Edit Purchase Order");
1952 # $::locale->text("Edit Quotation");
1953 # $::locale->text("Edit Request for Quotation");
1955 $action = ucfirst(lc($action));
1956 return $self->type eq sales_order_type() ? $::locale->text("$action Sales Order")
1957 : $self->type eq purchase_order_type() ? $::locale->text("$action Purchase Order")
1958 : $self->type eq sales_quotation_type() ? $::locale->text("$action Quotation")
1959 : $self->type eq request_quotation_type() ? $::locale->text("$action Request for Quotation")
1963 sub get_item_cvpartnumber {
1964 my ($self, $item) = @_;
1966 return if !$self->search_cvpartnumber;
1967 return if !$self->order->customervendor;
1969 if ($self->cv eq 'vendor') {
1970 my @mms = grep { $_->make eq $self->order->customervendor->id } @{$item->part->makemodels};
1971 $item->{cvpartnumber} = $mms[0]->model if scalar @mms;
1972 } elsif ($self->cv eq 'customer') {
1973 my @cps = grep { $_->customer_id eq $self->order->customervendor->id } @{$item->part->customerprices};
1974 $item->{cvpartnumber} = $cps[0]->customer_partnumber if scalar @cps;
1978 sub sales_order_type {
1982 sub purchase_order_type {
1986 sub sales_quotation_type {
1990 sub request_quotation_type {
1991 'request_quotation';
1995 return $_[0]->type eq sales_order_type() ? 'ordnumber'
1996 : $_[0]->type eq purchase_order_type() ? 'ordnumber'
1997 : $_[0]->type eq sales_quotation_type() ? 'quonumber'
1998 : $_[0]->type eq request_quotation_type() ? 'quonumber'
2010 SL::Controller::Order - controller for orders
2014 This is a new form to enter orders, completely rewritten with the use
2015 of controller and java script techniques.
2017 The aim is to provide the user a better experience and a faster workflow. Also
2018 the code should be more readable, more reliable and better to maintain.
2026 One input row, so that input happens every time at the same place.
2030 Use of pickers where possible.
2034 Possibility to enter more than one item at once.
2038 Item list in a scrollable area, so that the workflow buttons stay at
2043 Reordering item rows with drag and drop is possible. Sorting item rows is
2044 possible (by partnumber, description, qty, sellprice and discount for now).
2048 No C<update> is necessary. All entries and calculations are managed
2049 with ajax-calls and the page only reloads on C<save>.
2053 User can see changes immediately, because of the use of java script
2064 =item * C<SL/Controller/Order.pm>
2068 =item * C<template/webpages/order/form.html>
2072 =item * C<template/webpages/order/tabs/basic_data.html>
2074 Main tab for basic_data.
2076 This is the only tab here for now. "linked records" and "webdav" tabs are
2077 reused from generic code.
2081 =item * C<template/webpages/order/tabs/_business_info_row.html>
2083 For displaying information on business type
2085 =item * C<template/webpages/order/tabs/_item_input.html>
2087 The input line for items
2089 =item * C<template/webpages/order/tabs/_row.html>
2091 One row for already entered items
2093 =item * C<template/webpages/order/tabs/_tax_row.html>
2095 Displaying tax information
2097 =item * C<template/webpages/order/tabs/_multi_items_dialog.html>
2099 Dialog for entering more than one item at once
2101 =item * C<template/webpages/order/tabs/_multi_items_result.html>
2103 Results for the filter in the multi items dialog
2105 =item * C<template/webpages/order/tabs/_price_sources_dialog.html>
2107 Dialog for selecting price and discount sources
2111 =item * C<js/kivi.Order.js>
2113 java script functions
2123 =item * credit limit
2125 =item * more workflows (quotation, rfq)
2127 =item * price sources: little symbols showing better price / better discount
2129 =item * select units in input row?
2131 =item * custom shipto address
2133 =item * check for direct delivery (workflow sales order -> purchase order)
2135 =item * language / part translations
2137 =item * access rights
2139 =item * display weights
2145 =item * optional client/user behaviour
2147 (transactions has to be set - department has to be set -
2148 force project if enabled in client config - transport cost reminder)
2152 =head1 KNOWN BUGS AND CAVEATS
2158 Customer discount is not displayed as a valid discount in price source popup
2159 (this might be a bug in price sources)
2161 (I cannot reproduce this (Bernd))
2165 No indication that <shift>-up/down expands/collapses second row.
2169 Inline creation of parts is not currently supported
2173 Table header is not sticky in the scrolling area.
2177 Sorting does not include C<position>, neither does reordering.
2179 This behavior was implemented intentionally. But we can discuss, which behavior
2180 should be implemented.
2184 C<show_multi_items_dialog> does not use the currently inserted string for
2189 =head1 To discuss / Nice to have
2195 How to expand/collapse second row. Now it can be done clicking the icon or
2200 Possibility to change longdescription in input row?
2204 Possibility to select PriceSources in input row?
2208 This controller uses a (changed) copy of the template for the PriceSource
2209 dialog. Maybe there could be used one code source.
2213 Rounding-differences between this controller (PriceTaxCalculator) and the old
2214 form. This is not only a problem here, but also in all parts using the PTC.
2215 There exists a ticket and a patch. This patch should be testet.
2219 An indicator, if the actual inputs are saved (like in an
2220 editor or on text processing application).
2224 A warning when leaving the page without saveing unchanged inputs.
2231 Bernd Bleßmann E<lt>bernd@kivitendo-premium.deE<gt>