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($::form->round_amount($price_src->price / $self->order->exchangerate, 5)) if $self->order->exchangerate;
1048 $price_src->price(0) if !$price_source->best_price;
1052 $item->sellprice($price_src->price);
1053 $item->active_price_source($price_src);
1056 ->run('kivi.Order.update_sellprice', $item_id, $item->sellprice_as_number)
1057 ->html('.row_entry:has(#item_' . $item_id . ') [name = "partnumber"] a', $item->part->partnumber)
1058 ->val ('.row_entry:has(#item_' . $item_id . ') [name = "order.orderitems[].description"]', $item->description)
1059 ->val ('.row_entry:has(#item_' . $item_id . ') [name = "order.orderitems[].longdescription"]', $item->longdescription);
1061 if ($self->search_cvpartnumber) {
1062 $self->get_item_cvpartnumber($item);
1063 $self->js->html('.row_entry:has(#item_' . $item_id . ') [name = "cvpartnumber"]', $item->{cvpartnumber});
1068 $self->js_redisplay_line_values;
1069 $self->js_redisplay_amounts_and_taxes;
1071 $self->js->render();
1074 sub js_load_second_row {
1075 my ($self, $item, $item_id, $do_parse) = @_;
1078 # Parse values from form (they are formated while rendering (template)).
1079 # Workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
1080 # This parsing is not necessary at all, if we assure that the second row/cvars are only loaded once.
1081 foreach my $var (@{ $item->cvars_by_config }) {
1082 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
1084 $item->parse_custom_variable_values;
1087 my $row_as_html = $self->p->render('order/tabs/_second_row', ITEM => $item, TYPE => $self->type);
1090 ->html('#second_row_' . $item_id, $row_as_html)
1091 ->data('#second_row_' . $item_id, 'loaded', 1);
1094 sub js_redisplay_line_values {
1097 my $is_sales = $self->order->is_sales;
1099 # sales orders with margins
1104 $::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0),
1105 $::form->format_amount(\%::myconfig, $_->{marge_total}, 2, 0),
1106 $::form->format_amount(\%::myconfig, $_->{marge_percent}, 2, 0),
1107 ]} @{ $self->order->items_sorted };
1111 $::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0),
1112 ]} @{ $self->order->items_sorted };
1116 ->run('kivi.Order.redisplay_line_values', $is_sales, \@data);
1119 sub js_redisplay_amounts_and_taxes {
1122 if (scalar @{ $self->{taxes} }) {
1123 $self->js->show('#taxincluded_row_id');
1125 $self->js->hide('#taxincluded_row_id');
1128 if ($self->order->taxincluded) {
1129 $self->js->hide('#subtotal_row_id');
1131 $self->js->show('#subtotal_row_id');
1134 if ($self->order->is_sales) {
1135 my $is_neg = $self->order->marge_total < 0;
1137 ->html('#marge_total_id', $::form->format_amount(\%::myconfig, $self->order->marge_total, 2))
1138 ->html('#marge_percent_id', $::form->format_amount(\%::myconfig, $self->order->marge_percent, 2))
1139 ->action_if( $is_neg, 'addClass', '#marge_total_id', 'plus0')
1140 ->action_if( $is_neg, 'addClass', '#marge_percent_id', 'plus0')
1141 ->action_if( $is_neg, 'addClass', '#marge_percent_sign_id', 'plus0')
1142 ->action_if(!$is_neg, 'removeClass', '#marge_total_id', 'plus0')
1143 ->action_if(!$is_neg, 'removeClass', '#marge_percent_id', 'plus0')
1144 ->action_if(!$is_neg, 'removeClass', '#marge_percent_sign_id', 'plus0');
1148 ->html('#netamount_id', $::form->format_amount(\%::myconfig, $self->order->netamount, -2))
1149 ->html('#amount_id', $::form->format_amount(\%::myconfig, $self->order->amount, -2))
1150 ->remove('.tax_row')
1151 ->insertBefore($self->build_tax_rows, '#amount_row_id');
1154 sub js_redisplay_cvpartnumbers {
1157 $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
1159 my @data = map {[$_->{cvpartnumber}]} @{ $self->order->items_sorted };
1162 ->run('kivi.Order.redisplay_cvpartnumbers', \@data);
1165 sub js_reset_order_and_item_ids_after_save {
1169 ->val('#id', $self->order->id)
1170 ->val('#converted_from_oe_id', '')
1171 ->val('#order_' . $self->nr_key(), $self->order->number);
1174 foreach my $form_item_id (@{ $::form->{orderitem_ids} }) {
1175 next if !$self->order->items_sorted->[$idx]->id;
1176 next if $form_item_id !~ m{^new};
1178 ->val ('[name="orderitem_ids[+]"][value="' . $form_item_id . '"]', $self->order->items_sorted->[$idx]->id)
1179 ->val ('#item_' . $form_item_id, $self->order->items_sorted->[$idx]->id)
1180 ->attr('#item_' . $form_item_id, "id", 'item_' . $self->order->items_sorted->[$idx]->id);
1184 $self->js->val('[name="converted_from_orderitems_ids[+]"]', '');
1191 sub init_valid_types {
1192 [ sales_order_type(), purchase_order_type(), sales_quotation_type(), request_quotation_type() ];
1198 if (none { $::form->{type} eq $_ } @{$self->valid_types}) {
1199 die "Not a valid type for order";
1202 $self->type($::form->{type});
1208 my $cv = (any { $self->type eq $_ } (sales_order_type(), sales_quotation_type())) ? 'customer'
1209 : (any { $self->type eq $_ } (purchase_order_type(), request_quotation_type())) ? 'vendor'
1210 : die "Not a valid type for order";
1215 sub init_search_cvpartnumber {
1218 my $user_prefs = SL::Helper::UserPreferences::PartPickerSearch->new();
1219 my $search_cvpartnumber;
1220 $search_cvpartnumber = !!$user_prefs->get_sales_search_customer_partnumber() if $self->cv eq 'customer';
1221 $search_cvpartnumber = !!$user_prefs->get_purchase_search_makemodel() if $self->cv eq 'vendor';
1223 return $search_cvpartnumber;
1226 sub init_show_update_button {
1229 !!SL::Helper::UserPreferences::UpdatePositions->new()->get_show_update_button();
1240 # model used to filter/display the parts in the multi-items dialog
1241 sub init_multi_items_models {
1242 SL::Controller::Helper::GetModels->new(
1243 controller => $_[0],
1245 with_objects => [ qw(unit_obj) ],
1246 disable_plugin => 'paginated',
1247 source => $::form->{multi_items},
1253 partnumber => t8('Partnumber'),
1254 description => t8('Description')}
1258 sub init_all_price_factors {
1259 SL::DB::Manager::PriceFactor->get_all;
1265 my $right_for = { map { $_ => $_.'_edit' } @{$self->valid_types} };
1267 my $right = $right_for->{ $self->type };
1268 $right ||= 'DOES_NOT_EXIST';
1270 $::auth->assert($right);
1273 # build the selection box for contacts
1275 # Needed, if customer/vendor changed.
1276 sub build_contact_select {
1279 select_tag('order.cp_id', [ $self->order->{$self->cv}->contacts ],
1280 value_key => 'cp_id',
1281 title_key => 'full_name_dep',
1282 default => $self->order->cp_id,
1284 style => 'width: 300px',
1288 # build the selection box for shiptos
1290 # Needed, if customer/vendor changed.
1291 sub build_shipto_select {
1294 select_tag('order.shipto_id', [ $self->order->{$self->cv}->shipto ],
1295 value_key => 'shipto_id',
1296 title_key => 'displayable_id',
1297 default => $self->order->shipto_id,
1299 style => 'width: 300px',
1303 # render the info line for business
1305 # Needed, if customer/vendor changed.
1306 sub build_business_info_row
1308 $_[0]->p->render('order/tabs/_business_info_row', SELF => $_[0]);
1311 # build the rows for displaying taxes
1313 # Called if amounts where recalculated and redisplayed.
1314 sub build_tax_rows {
1318 foreach my $tax (sort { $a->{tax}->rate cmp $b->{tax}->rate } @{ $self->{taxes} }) {
1319 $rows_as_html .= $self->p->render('order/tabs/_tax_row', TAX => $tax, TAXINCLUDED => $self->order->taxincluded);
1321 return $rows_as_html;
1325 sub render_price_dialog {
1326 my ($self, $record_item) = @_;
1328 my $price_source = SL::PriceSource->new(record_item => $record_item, record => $self->order);
1332 'kivi.io.price_chooser_dialog',
1333 t8('Available Prices'),
1334 $self->render('order/tabs/_price_sources_dialog', { output => 0 }, price_source => $price_source)
1339 # $self->js->text('#dialog_flash_error_content', join ' ', @errors);
1340 # $self->js->show('#dialog_flash_error');
1349 return if !$::form->{id};
1351 $self->order(SL::DB::Order->new(id => $::form->{id})->load);
1354 # load or create a new order object
1356 # And assign changes from the form to this object.
1357 # If the order is loaded from db, check if items are deleted in the form,
1358 # remove them form the object and collect them for removing from db on saving.
1359 # Then create/update items from form (via make_item) and add them.
1363 # add_items adds items to an order with no items for saving, but they cannot
1364 # be retrieved via items until the order is saved. Adding empty items to new
1365 # order here solves this problem.
1367 $order = SL::DB::Order->new(id => $::form->{id})->load(with => [ 'orderitems', 'orderitems.part' ]) if $::form->{id};
1368 $order ||= SL::DB::Order->new(orderitems => [],
1369 quotation => (any { $self->type eq $_ } (sales_quotation_type(), request_quotation_type())),
1370 currency_id => $::instance_conf->get_currency_id());
1372 my $cv_id_method = $self->cv . '_id';
1373 if (!$::form->{id} && $::form->{$cv_id_method}) {
1374 $order->$cv_id_method($::form->{$cv_id_method});
1375 setup_order_from_cv($order);
1378 my $form_orderitems = delete $::form->{order}->{orderitems};
1379 my $form_periodic_invoices_config = delete $::form->{order}->{periodic_invoices_config};
1381 $order->assign_attributes(%{$::form->{order}});
1383 if (my $periodic_invoices_config_attrs = $form_periodic_invoices_config ? SL::YAML::Load($form_periodic_invoices_config) : undef) {
1384 my $periodic_invoices_config = $order->periodic_invoices_config || $order->periodic_invoices_config(SL::DB::PeriodicInvoicesConfig->new);
1385 $periodic_invoices_config->assign_attributes(%$periodic_invoices_config_attrs);
1388 # remove deleted items
1389 $self->item_ids_to_delete([]);
1390 foreach my $idx (reverse 0..$#{$order->orderitems}) {
1391 my $item = $order->orderitems->[$idx];
1392 if (none { $item->id == $_->{id} } @{$form_orderitems}) {
1393 splice @{$order->orderitems}, $idx, 1;
1394 push @{$self->item_ids_to_delete}, $item->id;
1400 foreach my $form_attr (@{$form_orderitems}) {
1401 my $item = make_item($order, $form_attr);
1402 $item->position($pos);
1406 $order->add_items(grep {!$_->id} @items);
1411 # create or update items from form
1413 # Make item objects from form values. For items already existing read from db.
1414 # Create a new item else. And assign attributes.
1416 my ($record, $attr) = @_;
1419 $item = first { $_->id == $attr->{id} } @{$record->items} if $attr->{id};
1421 my $is_new = !$item;
1423 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
1424 # they cannot be retrieved via custom_variables until the order/orderitem is
1425 # saved. Adding empty custom_variables to new orderitem here solves this problem.
1426 $item ||= SL::DB::OrderItem->new(custom_variables => []);
1428 $item->assign_attributes(%$attr);
1429 $item->longdescription($item->part->notes) if $is_new && !defined $attr->{longdescription};
1430 $item->project_id($record->globalproject_id) if $is_new && !defined $attr->{project_id};
1431 $item->lastcost($record->is_sales ? $item->part->lastcost : 0) if $is_new && !defined $attr->{lastcost_as_number};
1438 # This is used to add one item
1440 my ($record, $attr) = @_;
1442 my $item = SL::DB::OrderItem->new;
1444 # Remove attributes where the user left or set the inputs empty.
1445 # So these attributes will be undefined and we can distinguish them
1446 # from zero later on.
1447 for (qw(qty_as_number sellprice_as_number discount_as_percent)) {
1448 delete $attr->{$_} if $attr->{$_} eq '';
1451 $item->assign_attributes(%$attr);
1453 my $part = SL::DB::Part->new(id => $attr->{parts_id})->load;
1454 my $price_source = SL::PriceSource->new(record_item => $item, record => $record);
1456 $item->unit($part->unit) if !$item->unit;
1459 if ( $part->is_assortment ) {
1460 # add assortment items with price 0, as the components carry the price
1461 $price_src = $price_source->price_from_source("");
1462 $price_src->price(0);
1463 } elsif (defined $item->sellprice) {
1464 $price_src = $price_source->price_from_source("");
1465 $price_src->price($item->sellprice);
1467 $price_src = $price_source->best_price
1468 ? $price_source->best_price
1469 : $price_source->price_from_source("");
1470 $price_src->price($::form->round_amount($price_src->price / $record->exchangerate, 5)) if $record->exchangerate;
1471 $price_src->price(0) if !$price_source->best_price;
1475 if (defined $item->discount) {
1476 $discount_src = $price_source->discount_from_source("");
1477 $discount_src->discount($item->discount);
1479 $discount_src = $price_source->best_discount
1480 ? $price_source->best_discount
1481 : $price_source->discount_from_source("");
1482 $discount_src->discount(0) if !$price_source->best_discount;
1486 $new_attr{part} = $part;
1487 $new_attr{description} = $part->description if ! $item->description;
1488 $new_attr{qty} = 1.0 if ! $item->qty;
1489 $new_attr{price_factor_id} = $part->price_factor_id if ! $item->price_factor_id;
1490 $new_attr{sellprice} = $price_src->price;
1491 $new_attr{discount} = $discount_src->discount;
1492 $new_attr{active_price_source} = $price_src;
1493 $new_attr{active_discount_source} = $discount_src;
1494 $new_attr{longdescription} = $part->notes if ! defined $attr->{longdescription};
1495 $new_attr{project_id} = $record->globalproject_id;
1496 $new_attr{lastcost} = $record->is_sales ? $part->lastcost : 0;
1498 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
1499 # they cannot be retrieved via custom_variables until the order/orderitem is
1500 # saved. Adding empty custom_variables to new orderitem here solves this problem.
1501 $new_attr{custom_variables} = [];
1503 $item->assign_attributes(%new_attr);
1508 sub setup_order_from_cv {
1511 $order->$_($order->customervendor->$_) for (qw(taxzone_id payment_id delivery_term_id currency_id));
1513 $order->intnotes($order->customervendor->notes);
1515 if ($order->is_sales) {
1516 $order->salesman_id($order->customer->salesman_id || SL::DB::Manager::Employee->current->id);
1517 $order->taxincluded(defined($order->customer->taxincluded_checked)
1518 ? $order->customer->taxincluded_checked
1519 : $::myconfig{taxincluded_checked});
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 SL::DB::OrderItem->new(id => $_)->delete for @{$self->item_ids_to_delete || []};
1592 $self->order->save(cascade => 1);
1595 if ($::form->{converted_from_oe_id}) {
1596 my @converted_from_oe_ids = split ' ', $::form->{converted_from_oe_id};
1597 foreach my $converted_from_oe_id (@converted_from_oe_ids) {
1598 my $src = SL::DB::Order->new(id => $converted_from_oe_id)->load;
1599 $src->update_attributes(closed => 1) if $src->type =~ /_quotation$/;
1600 $src->link_to_record($self->order);
1602 if (scalar @{ $::form->{converted_from_orderitems_ids} || [] }) {
1604 foreach (@{ $self->order->items_sorted }) {
1605 my $from_id = $::form->{converted_from_orderitems_ids}->[$idx];
1607 SL::DB::RecordLink->new(from_table => 'orderitems',
1608 from_id => $from_id,
1609 to_table => 'orderitems',
1617 }) || push(@{$errors}, $db->error);
1622 sub workflow_sales_or_purchase_order {
1626 my $errors = $self->save();
1628 if (scalar @{ $errors }) {
1629 $self->js->flash('error', $_) foreach @{ $errors };
1630 return $self->js->render();
1633 my $destination_type = $::form->{type} eq sales_quotation_type() ? sales_order_type()
1634 : $::form->{type} eq request_quotation_type() ? purchase_order_type()
1635 : $::form->{type} eq purchase_order_type() ? sales_order_type()
1636 : $::form->{type} eq sales_order_type() ? purchase_order_type()
1639 $self->order(SL::DB::Order->new_from($self->order, destination_type => $destination_type));
1640 $self->{converted_from_oe_id} = delete $::form->{id};
1642 # set item ids to new fake id, to identify them as new items
1643 foreach my $item (@{$self->order->items_sorted}) {
1644 $item->{new_fake_id} = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
1648 $::form->{type} = $destination_type;
1649 $self->type($self->init_type);
1650 $self->cv ($self->init_cv);
1654 $self->get_unalterable_data();
1655 $self->pre_render();
1657 # trigger rendering values for second row/longdescription as hidden,
1658 # because they are loaded only on demand. So we need to keep the values
1660 $_->{render_second_row} = 1 for @{ $self->order->items_sorted };
1661 $_->{render_longdescription} = 1 for @{ $self->order->items_sorted };
1665 title => $self->get_title_for('edit'),
1666 %{$self->{template_args}}
1674 $self->{all_taxzones} = SL::DB::Manager::TaxZone->get_all_sorted();
1675 $self->{all_currencies} = SL::DB::Manager::Currency->get_all_sorted();
1676 $self->{all_departments} = SL::DB::Manager::Department->get_all_sorted();
1677 $self->{all_employees} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->employee_id,
1680 $self->{all_salesmen} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->salesman_id,
1683 $self->{all_payment_terms} = SL::DB::Manager::PaymentTerm->get_all_sorted(where => [ or => [ id => $self->order->payment_id,
1685 $self->{all_delivery_terms} = SL::DB::Manager::DeliveryTerm->get_all_sorted();
1686 $self->{current_employee_id} = SL::DB::Manager::Employee->current->id;
1687 $self->{periodic_invoices_status} = $self->get_periodic_invoices_status($self->order->periodic_invoices_config);
1688 $self->{order_probabilities} = [ map { { title => ($_ * 10) . '%', id => $_ * 10 } } (0..10) ];
1689 $self->{positions_scrollbar_height} = SL::Helper::UserPreferences::PositionsScrollbar->new()->get_height();
1691 my $print_form = Form->new('');
1692 $print_form->{type} = $self->type;
1693 $print_form->{printers} = SL::DB::Manager::Printer->get_all_sorted;
1694 $print_form->{languages} = SL::DB::Manager::Language->get_all_sorted;
1695 $print_form->{language_id} = $self->order->language_id;
1696 $self->{print_options} = SL::Helper::PrintOptions->get_print_options(
1697 form => $print_form,
1698 options => {dialog_name_prefix => 'print_options.',
1702 no_opendocument => 0,
1706 foreach my $item (@{$self->order->orderitems}) {
1707 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
1708 $item->active_price_source( $price_source->price_from_source( $item->active_price_source ));
1709 $item->active_discount_source($price_source->discount_from_source($item->active_discount_source));
1712 if (any { $self->type eq $_ } (sales_order_type(), purchase_order_type())) {
1713 # calculate shipped qtys here to prevent calling calculate for every item via the items method
1714 SL::Helper::ShippedQty->new->calculate($self->order)->write_to_objects;
1717 if ($self->order->number && $::instance_conf->get_webdav) {
1718 my $webdav = SL::Webdav->new(
1719 type => $self->type,
1720 number => $self->order->number,
1722 my @all_objects = $webdav->get_all_objects;
1723 @{ $self->{template_args}->{WEBDAV} } = map { { name => $_->filename,
1725 link => File::Spec->catfile($_->full_filedescriptor),
1729 $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
1731 $::request->{layout}->use_javascript("${_}.js") for qw(kivi.SalesPurchase kivi.Order kivi.File ckeditor/ckeditor ckeditor/adapters/jquery edit_periodic_invoices_config calculate_qty);
1732 $self->setup_edit_action_bar;
1735 sub setup_edit_action_bar {
1736 my ($self, %params) = @_;
1738 my $deletion_allowed = (any { $self->type eq $_ } (sales_quotation_type(), request_quotation_type()))
1739 || (($self->type eq sales_order_type()) && $::instance_conf->get_sales_order_show_delete)
1740 || (($self->type eq purchase_order_type()) && $::instance_conf->get_purchase_order_show_delete);
1742 for my $bar ($::request->layout->get('actionbar')) {
1747 call => [ 'kivi.Order.save', 'save', $::instance_conf->get_order_warn_duplicate_parts,
1748 $::instance_conf->get_order_warn_no_deliverydate,
1750 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1754 call => [ 'kivi.Order.save', 'save_as_new', $::instance_conf->get_order_warn_duplicate_parts ],
1755 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1756 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1758 ], # end of combobox "Save"
1765 t8('Save and Sales Order'),
1766 submit => [ '#order_form', { action => "Order/sales_order" } ],
1767 only_if => (any { $self->type eq $_ } (sales_quotation_type(), purchase_order_type())),
1768 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1771 t8('Save and Purchase Order'),
1772 submit => [ '#order_form', { action => "Order/purchase_order" } ],
1773 only_if => (any { $self->type eq $_ } (sales_order_type(), request_quotation_type())),
1774 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1777 t8('Save and Delivery Order'),
1778 call => [ 'kivi.Order.save', 'save_and_delivery_order', $::instance_conf->get_order_warn_duplicate_parts,
1779 $::instance_conf->get_order_warn_no_deliverydate,
1781 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1782 only_if => (any { $self->type eq $_ } (sales_order_type(), purchase_order_type()))
1785 t8('Save and Invoice'),
1786 call => [ 'kivi.Order.save', 'save_and_invoice', $::instance_conf->get_order_warn_duplicate_parts ],
1787 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1790 t8('Save and AP Transaction'),
1791 call => [ 'kivi.Order.save', 'save_and_ap_transaction', $::instance_conf->get_order_warn_duplicate_parts ],
1792 only_if => (any { $self->type eq $_ } (purchase_order_type()))
1795 ], # end of combobox "Workflow"
1802 t8('Save and print'),
1803 call => [ 'kivi.Order.show_print_options', $::instance_conf->get_order_warn_duplicate_parts ],
1806 t8('Save and E-mail'),
1807 call => [ 'kivi.Order.email', $::instance_conf->get_order_warn_duplicate_parts ],
1810 t8('Download attachments of all parts'),
1811 call => [ 'kivi.File.downloadOrderitemsFiles', $::form->{type}, $::form->{id} ],
1812 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1813 only_if => $::instance_conf->get_doc_storage,
1815 ], # end of combobox "Export"
1819 call => [ 'kivi.Order.delete_order' ],
1820 confirm => $::locale->text('Do you really want to delete this object?'),
1821 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1822 only_if => $deletion_allowed,
1829 my ($order, $pdf_ref, $params) = @_;
1833 my $print_form = Form->new('');
1834 $print_form->{type} = $order->type;
1835 $print_form->{formname} = $params->{formname} || $order->type;
1836 $print_form->{format} = $params->{format} || 'pdf';
1837 $print_form->{media} = $params->{media} || 'file';
1838 $print_form->{groupitems} = $params->{groupitems};
1839 $print_form->{media} = 'file' if $print_form->{media} eq 'screen';
1841 $order->language($params->{language});
1842 $order->flatten_to_form($print_form, format_amounts => 1);
1846 if ($print_form->{format} =~ /(opendocument|oasis)/i) {
1847 $template_ext = 'odt';
1848 $template_type = 'OpenDocument';
1851 # search for the template
1852 my ($template_file, @template_files) = SL::Helper::CreatePDF->find_template(
1853 name => $print_form->{formname},
1854 extension => $template_ext,
1855 email => $print_form->{media} eq 'email',
1856 language => $params->{language},
1857 printer_id => $print_form->{printer_id}, # todo
1860 if (!defined $template_file) {
1861 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);
1864 return @errors if scalar @errors;
1866 $print_form->throw_on_error(sub {
1868 $print_form->prepare_for_printing;
1870 $$pdf_ref = SL::Helper::CreatePDF->create_pdf(
1871 format => $print_form->{format},
1872 template_type => $template_type,
1873 template => $template_file,
1874 variables => $print_form,
1875 variable_content_types => {
1876 longdescription => 'html',
1877 partnotes => 'html',
1882 } || push @errors, ref($EVAL_ERROR) eq 'SL::X::FormError' ? $EVAL_ERROR->error : $EVAL_ERROR;
1888 sub get_files_for_email_dialog {
1891 my %files = map { ($_ => []) } qw(versions files vc_files part_files);
1893 return %files if !$::instance_conf->get_doc_storage;
1895 if ($self->order->id) {
1896 $files{versions} = [ SL::File->get_all_versions(object_id => $self->order->id, object_type => $self->order->type, file_type => 'document') ];
1897 $files{files} = [ SL::File->get_all( object_id => $self->order->id, object_type => $self->order->type, file_type => 'attachment') ];
1898 $files{vc_files} = [ SL::File->get_all( object_id => $self->order->{$self->cv}->id, object_type => $self->cv, file_type => 'attachment') ];
1902 uniq_by { $_->{id} }
1904 +{ id => $_->part->id,
1905 partnumber => $_->part->partnumber }
1906 } @{$self->order->items_sorted};
1908 foreach my $part (@parts) {
1909 my @pfiles = SL::File->get_all(object_id => $part->{id}, object_type => 'part');
1910 push @{ $files{part_files} }, map { +{ %{ $_ }, partnumber => $part->{partnumber} } } @pfiles;
1913 foreach my $key (keys %files) {
1914 $files{$key} = [ sort_by { lc $_->{db_file}->{file_name} } @{ $files{$key} } ];
1920 sub make_periodic_invoices_config_from_yaml {
1921 my ($yaml_config) = @_;
1923 return if !$yaml_config;
1924 my $attr = SL::YAML::Load($yaml_config);
1925 return if 'HASH' ne ref $attr;
1926 return SL::DB::PeriodicInvoicesConfig->new(%$attr);
1930 sub get_periodic_invoices_status {
1931 my ($self, $config) = @_;
1933 return if $self->type ne sales_order_type();
1934 return t8('not configured') if !$config;
1936 my $active = ('HASH' eq ref $config) ? $config->{active}
1937 : ('SL::DB::PeriodicInvoicesConfig' eq ref $config) ? $config->active
1938 : die "Cannot get status of periodic invoices config";
1940 return $active ? t8('active') : t8('inactive');
1944 my ($self, $action) = @_;
1946 return '' if none { lc($action)} qw(add edit);
1949 # $::locale->text("Add Sales Order");
1950 # $::locale->text("Add Purchase Order");
1951 # $::locale->text("Add Quotation");
1952 # $::locale->text("Add Request for Quotation");
1953 # $::locale->text("Edit Sales Order");
1954 # $::locale->text("Edit Purchase Order");
1955 # $::locale->text("Edit Quotation");
1956 # $::locale->text("Edit Request for Quotation");
1958 $action = ucfirst(lc($action));
1959 return $self->type eq sales_order_type() ? $::locale->text("$action Sales Order")
1960 : $self->type eq purchase_order_type() ? $::locale->text("$action Purchase Order")
1961 : $self->type eq sales_quotation_type() ? $::locale->text("$action Quotation")
1962 : $self->type eq request_quotation_type() ? $::locale->text("$action Request for Quotation")
1966 sub get_item_cvpartnumber {
1967 my ($self, $item) = @_;
1969 return if !$self->search_cvpartnumber;
1970 return if !$self->order->customervendor;
1972 if ($self->cv eq 'vendor') {
1973 my @mms = grep { $_->make eq $self->order->customervendor->id } @{$item->part->makemodels};
1974 $item->{cvpartnumber} = $mms[0]->model if scalar @mms;
1975 } elsif ($self->cv eq 'customer') {
1976 my @cps = grep { $_->customer_id eq $self->order->customervendor->id } @{$item->part->customerprices};
1977 $item->{cvpartnumber} = $cps[0]->customer_partnumber if scalar @cps;
1981 sub sales_order_type {
1985 sub purchase_order_type {
1989 sub sales_quotation_type {
1993 sub request_quotation_type {
1994 'request_quotation';
1998 return $_[0]->type eq sales_order_type() ? 'ordnumber'
1999 : $_[0]->type eq purchase_order_type() ? 'ordnumber'
2000 : $_[0]->type eq sales_quotation_type() ? 'quonumber'
2001 : $_[0]->type eq request_quotation_type() ? 'quonumber'
2013 SL::Controller::Order - controller for orders
2017 This is a new form to enter orders, completely rewritten with the use
2018 of controller and java script techniques.
2020 The aim is to provide the user a better experience and a faster workflow. Also
2021 the code should be more readable, more reliable and better to maintain.
2029 One input row, so that input happens every time at the same place.
2033 Use of pickers where possible.
2037 Possibility to enter more than one item at once.
2041 Item list in a scrollable area, so that the workflow buttons stay at
2046 Reordering item rows with drag and drop is possible. Sorting item rows is
2047 possible (by partnumber, description, qty, sellprice and discount for now).
2051 No C<update> is necessary. All entries and calculations are managed
2052 with ajax-calls and the page only reloads on C<save>.
2056 User can see changes immediately, because of the use of java script
2067 =item * C<SL/Controller/Order.pm>
2071 =item * C<template/webpages/order/form.html>
2075 =item * C<template/webpages/order/tabs/basic_data.html>
2077 Main tab for basic_data.
2079 This is the only tab here for now. "linked records" and "webdav" tabs are
2080 reused from generic code.
2084 =item * C<template/webpages/order/tabs/_business_info_row.html>
2086 For displaying information on business type
2088 =item * C<template/webpages/order/tabs/_item_input.html>
2090 The input line for items
2092 =item * C<template/webpages/order/tabs/_row.html>
2094 One row for already entered items
2096 =item * C<template/webpages/order/tabs/_tax_row.html>
2098 Displaying tax information
2100 =item * C<template/webpages/order/tabs/_multi_items_dialog.html>
2102 Dialog for entering more than one item at once
2104 =item * C<template/webpages/order/tabs/_multi_items_result.html>
2106 Results for the filter in the multi items dialog
2108 =item * C<template/webpages/order/tabs/_price_sources_dialog.html>
2110 Dialog for selecting price and discount sources
2114 =item * C<js/kivi.Order.js>
2116 java script functions
2126 =item * credit limit
2128 =item * more workflows (quotation, rfq)
2130 =item * price sources: little symbols showing better price / better discount
2132 =item * select units in input row?
2134 =item * custom shipto address
2136 =item * check for direct delivery (workflow sales order -> purchase order)
2138 =item * language / part translations
2140 =item * access rights
2142 =item * display weights
2148 =item * optional client/user behaviour
2150 (transactions has to be set - department has to be set -
2151 force project if enabled in client config - transport cost reminder)
2155 =head1 KNOWN BUGS AND CAVEATS
2161 Customer discount is not displayed as a valid discount in price source popup
2162 (this might be a bug in price sources)
2164 (I cannot reproduce this (Bernd))
2168 No indication that <shift>-up/down expands/collapses second row.
2172 Inline creation of parts is not currently supported
2176 Table header is not sticky in the scrolling area.
2180 Sorting does not include C<position>, neither does reordering.
2182 This behavior was implemented intentionally. But we can discuss, which behavior
2183 should be implemented.
2187 C<show_multi_items_dialog> does not use the currently inserted string for
2192 =head1 To discuss / Nice to have
2198 How to expand/collapse second row. Now it can be done clicking the icon or
2203 Possibility to change longdescription in input row?
2207 Possibility to select PriceSources in input row?
2211 This controller uses a (changed) copy of the template for the PriceSource
2212 dialog. Maybe there could be used one code source.
2216 Rounding-differences between this controller (PriceTaxCalculator) and the old
2217 form. This is not only a problem here, but also in all parts using the PTC.
2218 There exists a ticket and a patch. This patch should be testet.
2222 An indicator, if the actual inputs are saved (like in an
2223 editor or on text processing application).
2227 A warning when leaving the page without saveing unchanged inputs.
2234 Bernd Bleßmann E<lt>bernd@kivitendo-premium.deE<gt>