1 package SL::Controller::Order;
4 use parent qw(SL::Controller::Base);
6 use SL::Helper::Flash qw(flash_later);
7 use SL::Presenter::Tag qw(select_tag hidden_tag div_tag);
8 use SL::Locale::String qw(t8);
9 use SL::SessionFile::Random;
14 use SL::Util qw(trim);
20 use SL::DB::PartsGroup;
23 use SL::DB::RecordLink;
26 use SL::Helper::CreatePDF qw(:all);
27 use SL::Helper::PrintOptions;
28 use SL::Helper::ShippedQty;
29 use SL::Helper::UserPreferences::PositionsScrollbar;
30 use SL::Helper::UserPreferences::UpdatePositions;
32 use SL::Controller::Helper::GetModels;
34 use List::Util qw(first sum0);
35 use List::UtilsBy qw(sort_by uniq_by);
36 use List::MoreUtils qw(any none pairwise first_index);
37 use English qw(-no_match_vars);
42 use Rose::Object::MakeMethods::Generic
44 scalar => [ qw(item_ids_to_delete is_custom_shipto_to_delete) ],
45 'scalar --get_set_init' => [ qw(order valid_types type cv p multi_items_models all_price_factors search_cvpartnumber show_update_button) ],
50 __PACKAGE__->run_before('check_auth');
52 __PACKAGE__->run_before('recalc',
53 only => [ qw(save save_as_new save_and_delivery_order save_and_invoice save_and_ap_transaction
56 __PACKAGE__->run_before('get_unalterable_data',
57 only => [ qw(save save_as_new save_and_delivery_order save_and_invoice save_and_ap_transaction
68 $self->order->transdate(DateTime->now_local());
69 my $extra_days = $self->{type} eq 'sales_quotation' ? $::instance_conf->get_reqdate_interval :
70 $self->{type} eq 'sales_order' ? $::instance_conf->get_delivery_date_interval : 1;
71 $self->order->reqdate(DateTime->today_local->next_workday(extra_days => $extra_days)) if !$self->order->reqdate;
77 title => $self->get_title_for('add'),
78 %{$self->{template_args}}
82 # edit an existing order
90 # this is to edit an order from an unsaved order object
92 # set item ids to new fake id, to identify them as new items
93 foreach my $item (@{$self->order->items_sorted}) {
94 $item->{new_fake_id} = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
96 # trigger rendering values for second row/longdescription as hidden,
97 # because they are loaded only on demand. So we need to keep the values
99 $_->{render_second_row} = 1 for @{ $self->order->items_sorted };
100 $_->{render_longdescription} = 1 for @{ $self->order->items_sorted };
107 title => $self->get_title_for('edit'),
108 %{$self->{template_args}}
112 # edit a collective order (consisting of one or more existing orders)
113 sub action_edit_collective {
117 my @multi_ids = map {
118 $_ =~ m{^multi_id_(\d+)$} && $::form->{'multi_id_' . $1} && $::form->{'trans_id_' . $1} && $::form->{'trans_id_' . $1}
119 } grep { $_ =~ m{^multi_id_\d+$} } keys %$::form;
121 # fall back to add if no ids are given
122 if (scalar @multi_ids == 0) {
127 # fall back to save as new if only one id is given
128 if (scalar @multi_ids == 1) {
129 $self->order(SL::DB::Order->new(id => $multi_ids[0])->load);
130 $self->action_save_as_new();
134 # make new order from given orders
135 my @multi_orders = map { SL::DB::Order->new(id => $_)->load } @multi_ids;
136 $self->{converted_from_oe_id} = join ' ', map { $_->id } @multi_orders;
137 $self->order(SL::DB::Order->new_from_multi(\@multi_orders, sort_sources_by => 'transdate'));
139 $self->action_edit();
146 my $errors = $self->delete();
148 if (scalar @{ $errors }) {
149 $self->js->flash('error', $_) foreach @{ $errors };
150 return $self->js->render();
153 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been deleted')
154 : $self->type eq purchase_order_type() ? $::locale->text('The order has been deleted')
155 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been deleted')
156 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been deleted')
158 flash_later('info', $text);
160 my @redirect_params = (
165 $self->redirect_to(@redirect_params);
172 my $errors = $self->save();
174 if (scalar @{ $errors }) {
175 $self->js->flash('error', $_) foreach @{ $errors };
176 return $self->js->render();
179 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
180 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
181 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
182 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
184 flash_later('info', $text);
186 my @redirect_params = (
189 id => $self->order->id,
192 $self->redirect_to(@redirect_params);
195 # save the order as new document an open it for edit
196 sub action_save_as_new {
199 my $order = $self->order;
202 $self->js->flash('error', t8('This object has not been saved yet.'));
203 return $self->js->render();
206 # load order from db to check if values changed
207 my $saved_order = SL::DB::Order->new(id => $order->id)->load;
210 # Lets assign a new number if the user hasn't changed the previous one.
211 # If it has been changed manually then use it as-is.
212 $new_attrs{number} = (trim($order->number) eq $saved_order->number)
214 : trim($order->number);
216 # Clear transdate unless changed
217 $new_attrs{transdate} = ($order->transdate == $saved_order->transdate)
218 ? DateTime->today_local
221 # Set new reqdate unless changed
222 if ($order->reqdate == $saved_order->reqdate) {
223 my $extra_days = $self->{type} eq 'sales_quotation' ? $::instance_conf->get_reqdate_interval :
224 $self->{type} eq 'sales_order' ? $::instance_conf->get_delivery_date_interval : 1;
225 $new_attrs{reqdate} = DateTime->today_local->next_workday(extra_days => $extra_days);
227 $new_attrs{reqdate} = $order->reqdate;
231 $new_attrs{employee} = SL::DB::Manager::Employee->current;
233 # Create new record from current one
234 $self->order(SL::DB::Order->new_from($order, destination_type => $order->type, attributes => \%new_attrs));
236 # no linked records on save as new
237 delete $::form->{$_} for qw(converted_from_oe_id converted_from_orderitems_ids);
240 $self->action_save();
245 # This is called if "print" is pressed in the print dialog.
246 # If PDF creation was requested and succeeded, the pdf is offered for download
247 # via send_file (which uses ajax in this case).
251 my $errors = $self->save();
253 if (scalar @{ $errors }) {
254 $self->js->flash('error', $_) foreach @{ $errors };
255 return $self->js->render();
258 $self->js_reset_order_and_item_ids_after_save;
260 my $format = $::form->{print_options}->{format};
261 my $media = $::form->{print_options}->{media};
262 my $formname = $::form->{print_options}->{formname};
263 my $copies = $::form->{print_options}->{copies};
264 my $groupitems = $::form->{print_options}->{groupitems};
266 # only pdf and opendocument by now
267 if (none { $format eq $_ } qw(pdf opendocument opendocument_pdf)) {
268 return $self->js->flash('error', t8('Format \'#1\' is not supported yet/anymore.', $format))->render;
271 # only screen or printer by now
272 if (none { $media eq $_ } qw(screen printer)) {
273 return $self->js->flash('error', t8('Media \'#1\' is not supported yet/anymore.', $media))->render;
276 # create a form for generate_attachment_filename
277 my $form = Form->new;
278 $form->{$self->nr_key()} = $self->order->number;
279 $form->{type} = $self->type;
280 $form->{format} = $format;
281 $form->{formname} = $formname;
282 $form->{language} = '_' . $self->order->language->template_code if $self->order->language;
283 my $pdf_filename = $form->generate_attachment_filename();
286 my @errors = generate_pdf($self->order, \$pdf, { format => $format,
287 formname => $formname,
288 language => $self->order->language,
289 groupitems => $groupitems });
290 if (scalar @errors) {
291 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render;
294 if ($media eq 'screen') {
296 $self->js->flash('info', t8('The PDF has been created'));
299 type => SL::MIME->mime_type_from_ext($pdf_filename),
300 name => $pdf_filename,
304 } elsif ($media eq 'printer') {
306 my $printer_id = $::form->{print_options}->{printer_id};
307 SL::DB::Printer->new(id => $printer_id)->load->print_document(
312 $self->js->flash('info', t8('The PDF has been printed'));
315 # copy file to webdav folder
316 if ($self->order->number && $::instance_conf->get_webdav_documents) {
317 my $webdav = SL::Webdav->new(
319 number => $self->order->number,
321 my $webdav_file = SL::Webdav::File->new(
323 filename => $pdf_filename,
326 $webdav_file->store(data => \$pdf);
329 $self->js->flash('error', t8('Storing PDF to webdav folder failed: #1', $@));
332 if ($self->order->number && $::instance_conf->get_doc_storage) {
334 SL::File->save(object_id => $self->order->id,
335 object_type => $self->type,
336 mime_type => 'application/pdf',
338 file_type => 'document',
339 file_name => $pdf_filename,
340 file_contents => $pdf);
343 $self->js->flash('error', t8('Storing PDF in storage backend failed: #1', $@));
349 # open the email dialog
350 sub action_save_and_show_email_dialog {
353 my $errors = $self->save();
355 if (scalar @{ $errors }) {
356 $self->js->flash('error', $_) foreach @{ $errors };
357 return $self->js->render();
360 my $cv_method = $self->cv;
362 if (!$self->order->$cv_method) {
363 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'))
368 $email_form->{to} = $self->order->contact->cp_email if $self->order->contact;
369 $email_form->{to} ||= $self->order->$cv_method->email;
370 $email_form->{cc} = $self->order->$cv_method->cc;
371 $email_form->{bcc} = join ', ', grep $_, $self->order->$cv_method->bcc, SL::DB::Default->get->global_bcc;
372 # Todo: get addresses from shipto, if any
374 my $form = Form->new;
375 $form->{$self->nr_key()} = $self->order->number;
376 $form->{cusordnumber} = $self->order->cusordnumber;
377 $form->{formname} = $self->type;
378 $form->{type} = $self->type;
379 $form->{language} = '_' . $self->order->language->template_code if $self->order->language;
380 $form->{language_id} = $self->order->language->id if $self->order->language;
381 $form->{format} = 'pdf';
383 $email_form->{subject} = $form->generate_email_subject();
384 $email_form->{attachment_filename} = $form->generate_attachment_filename();
385 $email_form->{message} = $form->generate_email_body();
386 $email_form->{js_send_function} = 'kivi.Order.send_email()';
388 my %files = $self->get_files_for_email_dialog();
389 my $dialog_html = $self->render('common/_send_email_dialog', { output => 0 },
390 email_form => $email_form,
391 show_bcc => $::auth->assert('email_bcc', 'may fail'),
393 is_customer => $self->cv eq 'customer',
397 ->run('kivi.Order.show_email_dialog', $dialog_html)
404 # Todo: handling error messages: flash is not displayed in dialog, but in the main form
405 sub action_send_email {
408 my $errors = $self->save();
410 if (scalar @{ $errors }) {
411 $self->js->run('kivi.Order.close_email_dialog');
412 $self->js->flash('error', $_) foreach @{ $errors };
413 return $self->js->render();
416 $self->js_reset_order_and_item_ids_after_save;
418 my $email_form = delete $::form->{email_form};
419 my %field_names = (to => 'email');
421 $::form->{ $field_names{$_} // $_ } = $email_form->{$_} for keys %{ $email_form };
423 # for Form::cleanup which may be called in Form::send_email
424 $::form->{cwd} = getcwd();
425 $::form->{tmpdir} = $::lx_office_conf{paths}->{userspath};
427 $::form->{$_} = $::form->{print_options}->{$_} for keys %{ $::form->{print_options} };
428 $::form->{media} = 'email';
430 if (($::form->{attachment_policy} // '') !~ m{^(?:old_file|no_file)$}) {
432 my @errors = generate_pdf($self->order, \$pdf, {media => $::form->{media},
433 format => $::form->{print_options}->{format},
434 formname => $::form->{print_options}->{formname},
435 language => $self->order->language,
436 groupitems => $::form->{print_options}->{groupitems}});
437 if (scalar @errors) {
438 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
441 my $sfile = SL::SessionFile::Random->new(mode => "w");
442 $sfile->fh->print($pdf);
445 $::form->{tmpfile} = $sfile->file_name;
446 $::form->{tmpdir} = $sfile->get_path; # for Form::cleanup which may be called in Form::send_email
449 $::form->{id} = $self->order->id; # this is used in SL::Mailer to create a linked record to the mail
450 $::form->send_email(\%::myconfig, 'pdf');
453 my $intnotes = $self->order->intnotes;
454 $intnotes .= "\n\n" if $self->order->intnotes;
455 $intnotes .= t8('[email]') . "\n";
456 $intnotes .= t8('Date') . ": " . $::locale->format_date_object(DateTime->now_local, precision => 'seconds') . "\n";
457 $intnotes .= t8('To (email)') . ": " . $::form->{email} . "\n";
458 $intnotes .= t8('Cc') . ": " . $::form->{cc} . "\n" if $::form->{cc};
459 $intnotes .= t8('Bcc') . ": " . $::form->{bcc} . "\n" if $::form->{bcc};
460 $intnotes .= t8('Subject') . ": " . $::form->{subject} . "\n\n";
461 $intnotes .= t8('Message') . ": " . $::form->{message};
463 $self->order->update_attributes(intnotes => $intnotes);
465 flash_later('info', t8('The email has been sent.'));
467 my @redirect_params = (
470 id => $self->order->id,
473 $self->redirect_to(@redirect_params);
476 # open the periodic invoices config dialog
478 # If there are values in the form (i.e. dialog was opened before),
479 # then use this values. Create new ones, else.
480 sub action_show_periodic_invoices_config_dialog {
483 my $config = make_periodic_invoices_config_from_yaml(delete $::form->{config});
484 $config ||= SL::DB::Manager::PeriodicInvoicesConfig->find_by(oe_id => $::form->{id}) if $::form->{id};
485 $config ||= SL::DB::PeriodicInvoicesConfig->new(periodicity => 'm',
486 order_value_periodicity => 'p', # = same as periodicity
487 start_date_as_date => $::form->{transdate_as_date} || $::form->current_date,
488 extend_automatically_by => 12,
490 email_subject => GenericTranslations->get(
491 language_id => $::form->{language_id},
492 translation_type =>"preset_text_periodic_invoices_email_subject"),
493 email_body => GenericTranslations->get(
494 language_id => $::form->{language_id},
495 translation_type =>"preset_text_periodic_invoices_email_body"),
497 $config->periodicity('m') if none { $_ eq $config->periodicity } @SL::DB::PeriodicInvoicesConfig::PERIODICITIES;
498 $config->order_value_periodicity('p') if none { $_ eq $config->order_value_periodicity } ('p', @SL::DB::PeriodicInvoicesConfig::ORDER_VALUE_PERIODICITIES);
500 $::form->get_lists(printers => "ALL_PRINTERS",
501 charts => { key => 'ALL_CHARTS',
502 transdate => 'current_date' });
504 $::form->{AR} = [ grep { $_->{link} =~ m/(?:^|:)AR(?::|$)/ } @{ $::form->{ALL_CHARTS} } ];
506 if ($::form->{customer_id}) {
507 $::form->{ALL_CONTACTS} = SL::DB::Manager::Contact->get_all_sorted(where => [ cp_cv_id => $::form->{customer_id} ]);
508 $::form->{email_recipient_invoice_address} = SL::DB::Manager::Customer->find_by(id => $::form->{customer_id})->invoice_mail;
511 $self->render('oe/edit_periodic_invoices_config', { layout => 0 },
513 popup_js_close_function => 'kivi.Order.close_periodic_invoices_config_dialog()',
514 popup_js_assign_function => 'kivi.Order.assign_periodic_invoices_config()',
519 # assign the values of the periodic invoices config dialog
520 # as yaml in the hidden tag and set the status.
521 sub action_assign_periodic_invoices_config {
524 $::form->isblank('start_date_as_date', $::locale->text('The start date is missing.'));
526 my $config = { active => $::form->{active} ? 1 : 0,
527 terminated => $::form->{terminated} ? 1 : 0,
528 direct_debit => $::form->{direct_debit} ? 1 : 0,
529 periodicity => (any { $_ eq $::form->{periodicity} } @SL::DB::PeriodicInvoicesConfig::PERIODICITIES) ? $::form->{periodicity} : 'm',
530 order_value_periodicity => (any { $_ eq $::form->{order_value_periodicity} } ('p', @SL::DB::PeriodicInvoicesConfig::ORDER_VALUE_PERIODICITIES)) ? $::form->{order_value_periodicity} : 'p',
531 start_date_as_date => $::form->{start_date_as_date},
532 end_date_as_date => $::form->{end_date_as_date},
533 first_billing_date_as_date => $::form->{first_billing_date_as_date},
534 print => $::form->{print} ? 1 : 0,
535 printer_id => $::form->{print} ? $::form->{printer_id} * 1 : undef,
536 copies => $::form->{copies} * 1 ? $::form->{copies} : 1,
537 extend_automatically_by => $::form->{extend_automatically_by} * 1 || undef,
538 ar_chart_id => $::form->{ar_chart_id} * 1,
539 send_email => $::form->{send_email} ? 1 : 0,
540 email_recipient_contact_id => $::form->{email_recipient_contact_id} * 1 || undef,
541 email_recipient_address => $::form->{email_recipient_address},
542 email_sender => $::form->{email_sender},
543 email_subject => $::form->{email_subject},
544 email_body => $::form->{email_body},
547 my $periodic_invoices_config = SL::YAML::Dump($config);
549 my $status = $self->get_periodic_invoices_status($config);
552 ->remove('#order_periodic_invoices_config')
553 ->insertAfter(hidden_tag('order.periodic_invoices_config', $periodic_invoices_config), '#periodic_invoices_status')
554 ->run('kivi.Order.close_periodic_invoices_config_dialog')
555 ->html('#periodic_invoices_status', $status)
556 ->flash('info', t8('The periodic invoices config has been assigned.'))
560 sub action_get_has_active_periodic_invoices {
563 my $config = make_periodic_invoices_config_from_yaml(delete $::form->{config});
564 $config ||= SL::DB::Manager::PeriodicInvoicesConfig->find_by(oe_id => $::form->{id}) if $::form->{id};
566 my $has_active_periodic_invoices =
567 $self->type eq sales_order_type()
570 && (!$config->end_date || ($config->end_date > DateTime->today_local))
571 && $config->get_previous_billed_period_start_date;
573 $_[0]->render(\ !!$has_active_periodic_invoices, { type => 'text' });
576 # save the order and redirect to the frontend subroutine for a new
578 sub action_save_and_delivery_order {
581 my $errors = $self->save();
583 if (scalar @{ $errors }) {
584 $self->js->flash('error', $_) foreach @{ $errors };
585 return $self->js->render();
588 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
589 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
590 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
591 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
593 flash_later('info', $text);
595 my @redirect_params = (
596 controller => 'oe.pl',
597 action => 'oe_delivery_order_from_order',
598 id => $self->order->id,
601 $self->redirect_to(@redirect_params);
604 # save the order and redirect to the frontend subroutine for a new
606 sub action_save_and_invoice {
609 my $errors = $self->save();
611 if (scalar @{ $errors }) {
612 $self->js->flash('error', $_) foreach @{ $errors };
613 return $self->js->render();
616 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
617 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
618 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
619 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
621 flash_later('info', $text);
623 my @redirect_params = (
624 controller => 'oe.pl',
625 action => 'oe_invoice_from_order',
626 id => $self->order->id,
629 $self->redirect_to(@redirect_params);
632 # workflow from sales quotation to sales order
633 sub action_sales_order {
634 $_[0]->workflow_sales_or_purchase_order();
637 # workflow from rfq to purchase order
638 sub action_purchase_order {
639 $_[0]->workflow_sales_or_purchase_order();
642 # workflow from purchase order to ap transaction
643 sub action_save_and_ap_transaction {
646 my $errors = $self->save();
648 if (scalar @{ $errors }) {
649 $self->js->flash('error', $_) foreach @{ $errors };
650 return $self->js->render();
653 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
654 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
655 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
656 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
658 flash_later('info', $text);
660 my @redirect_params = (
661 controller => 'ap.pl',
662 action => 'add_from_purchase_order',
663 id => $self->order->id,
666 $self->redirect_to(@redirect_params);
669 # set form elements in respect to a changed customer or vendor
671 # This action is called on an change of the customer/vendor picker.
672 sub action_customer_vendor_changed {
675 setup_order_from_cv($self->order);
678 my $cv_method = $self->cv;
680 if ($self->order->$cv_method->contacts && scalar @{ $self->order->$cv_method->contacts } > 0) {
681 $self->js->show('#cp_row');
683 $self->js->hide('#cp_row');
686 if ($self->order->$cv_method->shipto && scalar @{ $self->order->$cv_method->shipto } > 0) {
687 $self->js->show('#shipto_selection');
689 $self->js->hide('#shipto_selection');
692 $self->js->val( '#order_salesman_id', $self->order->salesman_id) if $self->order->is_sales;
695 ->replaceWith('#order_cp_id', $self->build_contact_select)
696 ->replaceWith('#order_shipto_id', $self->build_shipto_select)
697 ->replaceWith('#shipto_inputs ', $self->build_shipto_inputs)
698 ->replaceWith('#business_info_row', $self->build_business_info_row)
699 ->val( '#order_taxzone_id', $self->order->taxzone_id)
700 ->val( '#order_taxincluded', $self->order->taxincluded)
701 ->val( '#order_currency_id', $self->order->currency_id)
702 ->val( '#order_payment_id', $self->order->payment_id)
703 ->val( '#order_delivery_term_id', $self->order->delivery_term_id)
704 ->val( '#order_intnotes', $self->order->intnotes)
705 ->val( '#order_language_id', $self->order->$cv_method->language_id)
706 ->focus( '#order_' . $self->cv . '_id')
707 ->run('kivi.Order.update_exchangerate');
709 $self->js_redisplay_amounts_and_taxes;
710 $self->js_redisplay_cvpartnumbers;
714 # open the dialog for customer/vendor details
715 sub action_show_customer_vendor_details_dialog {
718 my $is_customer = 'customer' eq $::form->{vc};
721 $cv = SL::DB::Customer->new(id => $::form->{vc_id})->load;
723 $cv = SL::DB::Vendor->new(id => $::form->{vc_id})->load;
726 my %details = map { $_ => $cv->$_ } @{$cv->meta->columns};
727 $details{discount_as_percent} = $cv->discount_as_percent;
728 $details{creditlimt} = $cv->creditlimit_as_number;
729 $details{business} = $cv->business->description if $cv->business;
730 $details{language} = $cv->language_obj->description if $cv->language_obj;
731 $details{delivery_terms} = $cv->delivery_term->description if $cv->delivery_term;
732 $details{payment_terms} = $cv->payment->description if $cv->payment;
733 $details{pricegroup} = $cv->pricegroup->pricegroup if $is_customer && $cv->pricegroup;
735 foreach my $entry (@{ $cv->shipto }) {
736 push @{ $details{SHIPTO} }, { map { $_ => $entry->$_ } @{$entry->meta->columns} };
738 foreach my $entry (@{ $cv->contacts }) {
739 push @{ $details{CONTACTS} }, { map { $_ => $entry->$_ } @{$entry->meta->columns} };
742 $_[0]->render('common/show_vc_details', { layout => 0 },
743 is_customer => $is_customer,
748 # called if a unit in an existing item row is changed
749 sub action_unit_changed {
752 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
753 my $item = $self->order->items_sorted->[$idx];
755 my $old_unit_obj = SL::DB::Unit->new(name => $::form->{old_unit})->load;
756 $item->sellprice($item->unit_obj->convert_to($item->sellprice, $old_unit_obj));
761 ->run('kivi.Order.update_sellprice', $::form->{item_id}, $item->sellprice_as_number);
762 $self->js_redisplay_line_values;
763 $self->js_redisplay_amounts_and_taxes;
767 # add an item row for a new item entered in the input row
768 sub action_add_item {
771 my $form_attr = $::form->{add_item};
773 return unless $form_attr->{parts_id};
775 my $item = new_item($self->order, $form_attr);
777 $self->order->add_items($item);
781 $self->get_item_cvpartnumber($item);
783 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
784 my $row_as_html = $self->p->render('order/tabs/_row',
790 if ($::form->{insert_before_item_id}) {
792 ->before ('.row_entry:has(#item_' . $::form->{insert_before_item_id} . ')', $row_as_html);
795 ->append('#row_table_id', $row_as_html);
798 if ( $item->part->is_assortment ) {
799 $form_attr->{qty_as_number} = 1 unless $form_attr->{qty_as_number};
800 foreach my $assortment_item ( @{$item->part->assortment_items} ) {
801 my $attr = { parts_id => $assortment_item->parts_id,
802 qty => $assortment_item->qty * $::form->parse_amount(\%::myconfig, $form_attr->{qty_as_number}), # TODO $form_attr->{unit}
803 unit => $assortment_item->unit,
804 description => $assortment_item->part->description,
806 my $item = new_item($self->order, $attr);
808 # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount
809 $item->discount(1) unless $assortment_item->charge;
811 $self->order->add_items( $item );
813 $self->get_item_cvpartnumber($item);
814 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
815 my $row_as_html = $self->p->render('order/tabs/_row',
820 if ($::form->{insert_before_item_id}) {
822 ->before ('.row_entry:has(#item_' . $::form->{insert_before_item_id} . ')', $row_as_html);
825 ->append('#row_table_id', $row_as_html);
831 ->val('.add_item_input', '')
832 ->run('kivi.Order.init_row_handlers')
833 ->run('kivi.Order.renumber_positions')
834 ->focus('#add_item_parts_id_name');
836 $self->js->run('kivi.Order.row_table_scroll_down') if !$::form->{insert_before_item_id};
838 $self->js_redisplay_amounts_and_taxes;
842 # open the dialog for entering multiple items at once
843 sub action_show_multi_items_dialog {
844 $_[0]->render('order/tabs/_multi_items_dialog', { layout => 0 },
845 all_partsgroups => SL::DB::Manager::PartsGroup->get_all);
848 # update the filter results in the multi item dialog
849 sub action_multi_items_update_result {
852 $::form->{multi_items}->{filter}->{obsolete} = 0;
854 my $count = $_[0]->multi_items_models->count;
857 my $text = SL::Presenter::EscapedText->new(text => $::locale->text('No results.'));
858 $_[0]->render($text, { layout => 0 });
859 } elsif ($count > $max_count) {
860 my $text = SL::Presenter::EscapedText->new(text => $::locale->text('Too many results (#1 from #2).', $count, $max_count));
861 $_[0]->render($text, { layout => 0 });
863 my $multi_items = $_[0]->multi_items_models->get;
864 $_[0]->render('order/tabs/_multi_items_result', { layout => 0 },
865 multi_items => $multi_items);
869 # add item rows for multiple items at once
870 sub action_add_multi_items {
873 my @form_attr = grep { $_->{qty_as_number} } @{ $::form->{add_multi_items} };
874 return $self->js->render() unless scalar @form_attr;
877 foreach my $attr (@form_attr) {
878 my $item = new_item($self->order, $attr);
880 if ( $item->part->is_assortment ) {
881 foreach my $assortment_item ( @{$item->part->assortment_items} ) {
882 my $attr = { parts_id => $assortment_item->parts_id,
883 qty => $assortment_item->qty * $item->qty, # TODO $form_attr->{unit}
884 unit => $assortment_item->unit,
885 description => $assortment_item->part->description,
887 my $item = new_item($self->order, $attr);
889 # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount
890 $item->discount(1) unless $assortment_item->charge;
895 $self->order->add_items(@items);
899 foreach my $item (@items) {
900 $self->get_item_cvpartnumber($item);
901 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
902 my $row_as_html = $self->p->render('order/tabs/_row',
908 if ($::form->{insert_before_item_id}) {
910 ->before ('.row_entry:has(#item_' . $::form->{insert_before_item_id} . ')', $row_as_html);
913 ->append('#row_table_id', $row_as_html);
918 ->run('kivi.Order.close_multi_items_dialog')
919 ->run('kivi.Order.init_row_handlers')
920 ->run('kivi.Order.renumber_positions')
921 ->focus('#add_item_parts_id_name');
923 $self->js->run('kivi.Order.row_table_scroll_down') if !$::form->{insert_before_item_id};
925 $self->js_redisplay_amounts_and_taxes;
929 # recalculate all linetotals, amounts and taxes and redisplay them
930 sub action_recalc_amounts_and_taxes {
935 $self->js_redisplay_line_values;
936 $self->js_redisplay_amounts_and_taxes;
940 sub action_update_exchangerate {
944 is_standard => $self->order->currency_id == $::instance_conf->get_currency_id,
945 currency_name => $self->order->currency->name,
946 exchangerate => $self->order->daily_exchangerate_as_null_number,
949 $self->render(\SL::JSON::to_json($data), { type => 'json', process => 0 });
952 # redisplay item rows if they are sorted by an attribute
953 sub action_reorder_items {
957 partnumber => sub { $_[0]->part->partnumber },
958 description => sub { $_[0]->description },
959 qty => sub { $_[0]->qty },
960 sellprice => sub { $_[0]->sellprice },
961 discount => sub { $_[0]->discount },
962 cvpartnumber => sub { $_[0]->{cvpartnumber} },
965 $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
967 my $method = $sort_keys{$::form->{order_by}};
968 my @to_sort = map { { old_pos => $_->position, order_by => $method->($_) } } @{ $self->order->items_sorted };
969 if ($::form->{sort_dir}) {
970 if ( $::form->{order_by} =~ m/qty|sellprice|discount/ ){
971 @to_sort = sort { $a->{order_by} <=> $b->{order_by} } @to_sort;
973 @to_sort = sort { $a->{order_by} cmp $b->{order_by} } @to_sort;
976 if ( $::form->{order_by} =~ m/qty|sellprice|discount/ ){
977 @to_sort = sort { $b->{order_by} <=> $a->{order_by} } @to_sort;
979 @to_sort = sort { $b->{order_by} cmp $a->{order_by} } @to_sort;
983 ->run('kivi.Order.redisplay_items', \@to_sort)
987 # show the popup to choose a price/discount source
988 sub action_price_popup {
991 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
992 my $item = $self->order->items_sorted->[$idx];
994 $self->render_price_dialog($item);
997 # get the longdescription for an item if the dialog to enter/change the
998 # longdescription was opened and the longdescription is empty
1000 # If this item is new, get the longdescription from Part.
1001 # Otherwise get it from OrderItem.
1002 sub action_get_item_longdescription {
1003 my $longdescription;
1005 if ($::form->{item_id}) {
1006 $longdescription = SL::DB::OrderItem->new(id => $::form->{item_id})->load->longdescription;
1007 } elsif ($::form->{parts_id}) {
1008 $longdescription = SL::DB::Part->new(id => $::form->{parts_id})->load->notes;
1010 $_[0]->render(\ $longdescription, { type => 'text' });
1013 # load the second row for one or more items
1015 # This action gets the html code for all items second rows by rendering a template for
1016 # the second row and sets the html code via client js.
1017 sub action_load_second_rows {
1020 $self->recalc() if $self->order->is_sales; # for margin calculation
1022 foreach my $item_id (@{ $::form->{item_ids} }) {
1023 my $idx = first_index { $_ eq $item_id } @{ $::form->{orderitem_ids} };
1024 my $item = $self->order->items_sorted->[$idx];
1026 $self->js_load_second_row($item, $item_id, 0);
1029 $self->js->run('kivi.Order.init_row_handlers') if $self->order->is_sales; # for lastcosts change-callback
1031 $self->js->render();
1034 # update description, notes and sellprice from master data
1035 sub action_update_row_from_master_data {
1038 foreach my $item_id (@{ $::form->{item_ids} }) {
1039 my $idx = first_index { $_ eq $item_id } @{ $::form->{orderitem_ids} };
1040 my $item = $self->order->items_sorted->[$idx];
1042 $item->description($item->part->description);
1043 $item->longdescription($item->part->notes);
1045 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
1048 if ($item->part->is_assortment) {
1049 # add assortment items with price 0, as the components carry the price
1050 $price_src = $price_source->price_from_source("");
1051 $price_src->price(0);
1053 $price_src = $price_source->best_price
1054 ? $price_source->best_price
1055 : $price_source->price_from_source("");
1056 $price_src->price($::form->round_amount($price_src->price / $self->order->exchangerate, 5)) if $self->order->exchangerate;
1057 $price_src->price(0) if !$price_source->best_price;
1061 $item->sellprice($price_src->price);
1062 $item->active_price_source($price_src);
1065 ->run('kivi.Order.update_sellprice', $item_id, $item->sellprice_as_number)
1066 ->html('.row_entry:has(#item_' . $item_id . ') [name = "partnumber"] a', $item->part->partnumber)
1067 ->val ('.row_entry:has(#item_' . $item_id . ') [name = "order.orderitems[].description"]', $item->description)
1068 ->val ('.row_entry:has(#item_' . $item_id . ') [name = "order.orderitems[].longdescription"]', $item->longdescription);
1070 if ($self->search_cvpartnumber) {
1071 $self->get_item_cvpartnumber($item);
1072 $self->js->html('.row_entry:has(#item_' . $item_id . ') [name = "cvpartnumber"]', $item->{cvpartnumber});
1077 $self->js_redisplay_line_values;
1078 $self->js_redisplay_amounts_and_taxes;
1080 $self->js->render();
1083 sub js_load_second_row {
1084 my ($self, $item, $item_id, $do_parse) = @_;
1087 # Parse values from form (they are formated while rendering (template)).
1088 # Workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
1089 # This parsing is not necessary at all, if we assure that the second row/cvars are only loaded once.
1090 foreach my $var (@{ $item->cvars_by_config }) {
1091 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
1093 $item->parse_custom_variable_values;
1096 my $row_as_html = $self->p->render('order/tabs/_second_row', ITEM => $item, TYPE => $self->type);
1099 ->html('#second_row_' . $item_id, $row_as_html)
1100 ->data('#second_row_' . $item_id, 'loaded', 1);
1103 sub js_redisplay_line_values {
1106 my $is_sales = $self->order->is_sales;
1108 # sales orders with margins
1113 $::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0),
1114 $::form->format_amount(\%::myconfig, $_->{marge_total}, 2, 0),
1115 $::form->format_amount(\%::myconfig, $_->{marge_percent}, 2, 0),
1116 ]} @{ $self->order->items_sorted };
1120 $::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0),
1121 ]} @{ $self->order->items_sorted };
1125 ->run('kivi.Order.redisplay_line_values', $is_sales, \@data);
1128 sub js_redisplay_amounts_and_taxes {
1131 if (scalar @{ $self->{taxes} }) {
1132 $self->js->show('#taxincluded_row_id');
1134 $self->js->hide('#taxincluded_row_id');
1137 if ($self->order->taxincluded) {
1138 $self->js->hide('#subtotal_row_id');
1140 $self->js->show('#subtotal_row_id');
1143 if ($self->order->is_sales) {
1144 my $is_neg = $self->order->marge_total < 0;
1146 ->html('#marge_total_id', $::form->format_amount(\%::myconfig, $self->order->marge_total, 2))
1147 ->html('#marge_percent_id', $::form->format_amount(\%::myconfig, $self->order->marge_percent, 2))
1148 ->action_if( $is_neg, 'addClass', '#marge_total_id', 'plus0')
1149 ->action_if( $is_neg, 'addClass', '#marge_percent_id', 'plus0')
1150 ->action_if( $is_neg, 'addClass', '#marge_percent_sign_id', 'plus0')
1151 ->action_if(!$is_neg, 'removeClass', '#marge_total_id', 'plus0')
1152 ->action_if(!$is_neg, 'removeClass', '#marge_percent_id', 'plus0')
1153 ->action_if(!$is_neg, 'removeClass', '#marge_percent_sign_id', 'plus0');
1157 ->html('#netamount_id', $::form->format_amount(\%::myconfig, $self->order->netamount, -2))
1158 ->html('#amount_id', $::form->format_amount(\%::myconfig, $self->order->amount, -2))
1159 ->remove('.tax_row')
1160 ->insertBefore($self->build_tax_rows, '#amount_row_id');
1163 sub js_redisplay_cvpartnumbers {
1166 $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
1168 my @data = map {[$_->{cvpartnumber}]} @{ $self->order->items_sorted };
1171 ->run('kivi.Order.redisplay_cvpartnumbers', \@data);
1174 sub js_reset_order_and_item_ids_after_save {
1178 ->val('#id', $self->order->id)
1179 ->val('#converted_from_oe_id', '')
1180 ->val('#order_' . $self->nr_key(), $self->order->number);
1183 foreach my $form_item_id (@{ $::form->{orderitem_ids} }) {
1184 next if !$self->order->items_sorted->[$idx]->id;
1185 next if $form_item_id !~ m{^new};
1187 ->val ('[name="orderitem_ids[+]"][value="' . $form_item_id . '"]', $self->order->items_sorted->[$idx]->id)
1188 ->val ('#item_' . $form_item_id, $self->order->items_sorted->[$idx]->id)
1189 ->attr('#item_' . $form_item_id, "id", 'item_' . $self->order->items_sorted->[$idx]->id);
1193 $self->js->val('[name="converted_from_orderitems_ids[+]"]', '');
1200 sub init_valid_types {
1201 [ sales_order_type(), purchase_order_type(), sales_quotation_type(), request_quotation_type() ];
1207 if (none { $::form->{type} eq $_ } @{$self->valid_types}) {
1208 die "Not a valid type for order";
1211 $self->type($::form->{type});
1217 my $cv = (any { $self->type eq $_ } (sales_order_type(), sales_quotation_type())) ? 'customer'
1218 : (any { $self->type eq $_ } (purchase_order_type(), request_quotation_type())) ? 'vendor'
1219 : die "Not a valid type for order";
1224 sub init_search_cvpartnumber {
1227 my $user_prefs = SL::Helper::UserPreferences::PartPickerSearch->new();
1228 my $search_cvpartnumber;
1229 $search_cvpartnumber = !!$user_prefs->get_sales_search_customer_partnumber() if $self->cv eq 'customer';
1230 $search_cvpartnumber = !!$user_prefs->get_purchase_search_makemodel() if $self->cv eq 'vendor';
1232 return $search_cvpartnumber;
1235 sub init_show_update_button {
1238 !!SL::Helper::UserPreferences::UpdatePositions->new()->get_show_update_button();
1249 # model used to filter/display the parts in the multi-items dialog
1250 sub init_multi_items_models {
1251 SL::Controller::Helper::GetModels->new(
1252 controller => $_[0],
1254 with_objects => [ qw(unit_obj) ],
1255 disable_plugin => 'paginated',
1256 source => $::form->{multi_items},
1262 partnumber => t8('Partnumber'),
1263 description => t8('Description')}
1267 sub init_all_price_factors {
1268 SL::DB::Manager::PriceFactor->get_all;
1274 my $right_for = { map { $_ => $_.'_edit' } @{$self->valid_types} };
1276 my $right = $right_for->{ $self->type };
1277 $right ||= 'DOES_NOT_EXIST';
1279 $::auth->assert($right);
1282 # build the selection box for contacts
1284 # Needed, if customer/vendor changed.
1285 sub build_contact_select {
1288 select_tag('order.cp_id', [ $self->order->{$self->cv}->contacts ],
1289 value_key => 'cp_id',
1290 title_key => 'full_name_dep',
1291 default => $self->order->cp_id,
1293 style => 'width: 300px',
1297 # build the selection box for shiptos
1299 # Needed, if customer/vendor changed.
1300 sub build_shipto_select {
1303 select_tag('order.shipto_id',
1304 [ {displayable_id => t8("No/individual shipping address"), shipto_id => ''}, $self->order->{$self->cv}->shipto ],
1305 value_key => 'shipto_id',
1306 title_key => 'displayable_id',
1307 default => $self->order->shipto_id,
1309 style => 'width: 300px',
1313 # build the inputs for the cusom shipto dialog
1315 # Needed, if customer/vendor changed.
1316 sub build_shipto_inputs {
1319 my $content = $self->p->render('common/_ship_to_dialog',
1320 vc_obj => $self->order->customervendor,
1321 cs_obj => $self->order->custom_shipto,
1322 cvars => $self->order->custom_shipto->cvars_by_config,
1323 id_selector => '#order_shipto_id');
1325 div_tag($content, id => 'shipto_inputs');
1328 # render the info line for business
1330 # Needed, if customer/vendor changed.
1331 sub build_business_info_row
1333 $_[0]->p->render('order/tabs/_business_info_row', SELF => $_[0]);
1336 # build the rows for displaying taxes
1338 # Called if amounts where recalculated and redisplayed.
1339 sub build_tax_rows {
1343 foreach my $tax (sort { $a->{tax}->rate cmp $b->{tax}->rate } @{ $self->{taxes} }) {
1344 $rows_as_html .= $self->p->render('order/tabs/_tax_row', TAX => $tax, TAXINCLUDED => $self->order->taxincluded);
1346 return $rows_as_html;
1350 sub render_price_dialog {
1351 my ($self, $record_item) = @_;
1353 my $price_source = SL::PriceSource->new(record_item => $record_item, record => $self->order);
1357 'kivi.io.price_chooser_dialog',
1358 t8('Available Prices'),
1359 $self->render('order/tabs/_price_sources_dialog', { output => 0 }, price_source => $price_source)
1364 # $self->js->text('#dialog_flash_error_content', join ' ', @errors);
1365 # $self->js->show('#dialog_flash_error');
1374 return if !$::form->{id};
1376 $self->order(SL::DB::Order->new(id => $::form->{id})->load);
1378 # Add an empty custom shipto to the order, so that the dialog can render the cvar inputs.
1379 # You need a custom shipto object to call cvars_by_config to get the cvars.
1380 $self->order->custom_shipto(SL::DB::Shipto->new(module => 'OE', custom_variables => [])) if !$self->order->custom_shipto;
1382 return $self->order;
1385 # load or create a new order object
1387 # And assign changes from the form to this object.
1388 # If the order is loaded from db, check if items are deleted in the form,
1389 # remove them form the object and collect them for removing from db on saving.
1390 # Then create/update items from form (via make_item) and add them.
1394 # add_items adds items to an order with no items for saving, but they cannot
1395 # be retrieved via items until the order is saved. Adding empty items to new
1396 # order here solves this problem.
1398 $order = SL::DB::Order->new(id => $::form->{id})->load(with => [ 'orderitems', 'orderitems.part' ]) if $::form->{id};
1399 $order ||= SL::DB::Order->new(orderitems => [],
1400 quotation => (any { $self->type eq $_ } (sales_quotation_type(), request_quotation_type())),
1401 currency_id => $::instance_conf->get_currency_id(),);
1403 my $cv_id_method = $self->cv . '_id';
1404 if (!$::form->{id} && $::form->{$cv_id_method}) {
1405 $order->$cv_id_method($::form->{$cv_id_method});
1406 setup_order_from_cv($order);
1409 my $form_orderitems = delete $::form->{order}->{orderitems};
1410 my $form_periodic_invoices_config = delete $::form->{order}->{periodic_invoices_config};
1412 $order->assign_attributes(%{$::form->{order}});
1414 $self->setup_custom_shipto_from_form($order, $::form);
1416 if (my $periodic_invoices_config_attrs = $form_periodic_invoices_config ? SL::YAML::Load($form_periodic_invoices_config) : undef) {
1417 my $periodic_invoices_config = $order->periodic_invoices_config || $order->periodic_invoices_config(SL::DB::PeriodicInvoicesConfig->new);
1418 $periodic_invoices_config->assign_attributes(%$periodic_invoices_config_attrs);
1421 # remove deleted items
1422 $self->item_ids_to_delete([]);
1423 foreach my $idx (reverse 0..$#{$order->orderitems}) {
1424 my $item = $order->orderitems->[$idx];
1425 if (none { $item->id == $_->{id} } @{$form_orderitems}) {
1426 splice @{$order->orderitems}, $idx, 1;
1427 push @{$self->item_ids_to_delete}, $item->id;
1433 foreach my $form_attr (@{$form_orderitems}) {
1434 my $item = make_item($order, $form_attr);
1435 $item->position($pos);
1439 $order->add_items(grep {!$_->id} @items);
1444 # create or update items from form
1446 # Make item objects from form values. For items already existing read from db.
1447 # Create a new item else. And assign attributes.
1449 my ($record, $attr) = @_;
1452 $item = first { $_->id == $attr->{id} } @{$record->items} if $attr->{id};
1454 my $is_new = !$item;
1456 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
1457 # they cannot be retrieved via custom_variables until the order/orderitem is
1458 # saved. Adding empty custom_variables to new orderitem here solves this problem.
1459 $item ||= SL::DB::OrderItem->new(custom_variables => []);
1461 $item->assign_attributes(%$attr);
1462 $item->longdescription($item->part->notes) if $is_new && !defined $attr->{longdescription};
1463 $item->project_id($record->globalproject_id) if $is_new && !defined $attr->{project_id};
1464 $item->lastcost($record->is_sales ? $item->part->lastcost : 0) if $is_new && !defined $attr->{lastcost_as_number};
1471 # This is used to add one item
1473 my ($record, $attr) = @_;
1475 my $item = SL::DB::OrderItem->new;
1477 # Remove attributes where the user left or set the inputs empty.
1478 # So these attributes will be undefined and we can distinguish them
1479 # from zero later on.
1480 for (qw(qty_as_number sellprice_as_number discount_as_percent)) {
1481 delete $attr->{$_} if $attr->{$_} eq '';
1484 $item->assign_attributes(%$attr);
1486 my $part = SL::DB::Part->new(id => $attr->{parts_id})->load;
1487 my $price_source = SL::PriceSource->new(record_item => $item, record => $record);
1489 $item->unit($part->unit) if !$item->unit;
1492 if ( $part->is_assortment ) {
1493 # add assortment items with price 0, as the components carry the price
1494 $price_src = $price_source->price_from_source("");
1495 $price_src->price(0);
1496 } elsif (defined $item->sellprice) {
1497 $price_src = $price_source->price_from_source("");
1498 $price_src->price($item->sellprice);
1500 $price_src = $price_source->best_price
1501 ? $price_source->best_price
1502 : $price_source->price_from_source("");
1503 $price_src->price($::form->round_amount($price_src->price / $record->exchangerate, 5)) if $record->exchangerate;
1504 $price_src->price(0) if !$price_source->best_price;
1508 if (defined $item->discount) {
1509 $discount_src = $price_source->discount_from_source("");
1510 $discount_src->discount($item->discount);
1512 $discount_src = $price_source->best_discount
1513 ? $price_source->best_discount
1514 : $price_source->discount_from_source("");
1515 $discount_src->discount(0) if !$price_source->best_discount;
1519 $new_attr{part} = $part;
1520 $new_attr{description} = $part->description if ! $item->description;
1521 $new_attr{qty} = 1.0 if ! $item->qty;
1522 $new_attr{price_factor_id} = $part->price_factor_id if ! $item->price_factor_id;
1523 $new_attr{sellprice} = $price_src->price;
1524 $new_attr{discount} = $discount_src->discount;
1525 $new_attr{active_price_source} = $price_src;
1526 $new_attr{active_discount_source} = $discount_src;
1527 $new_attr{longdescription} = $part->notes if ! defined $attr->{longdescription};
1528 $new_attr{project_id} = $record->globalproject_id;
1529 $new_attr{lastcost} = $record->is_sales ? $part->lastcost : 0;
1531 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
1532 # they cannot be retrieved via custom_variables until the order/orderitem is
1533 # saved. Adding empty custom_variables to new orderitem here solves this problem.
1534 $new_attr{custom_variables} = [];
1536 $item->assign_attributes(%new_attr);
1541 sub setup_order_from_cv {
1544 $order->$_($order->customervendor->$_) for (qw(taxzone_id payment_id delivery_term_id currency_id));
1546 $order->intnotes($order->customervendor->notes);
1548 if ($order->is_sales) {
1549 $order->salesman_id($order->customer->salesman_id || SL::DB::Manager::Employee->current->id);
1550 $order->taxincluded(defined($order->customer->taxincluded_checked)
1551 ? $order->customer->taxincluded_checked
1552 : $::myconfig{taxincluded_checked});
1557 # setup custom shipto from form
1559 # The dialog returns form variables starting with 'shipto' and cvars starting
1560 # with 'shiptocvar_'.
1561 # Mark it to be deleted if a shipto from master data is selected
1562 # (i.e. order has a shipto).
1563 # Else, update or create a new custom shipto. If the fields are empty, it
1564 # will not be saved on save.
1565 sub setup_custom_shipto_from_form {
1566 my ($self, $order, $form) = @_;
1568 if ($order->shipto) {
1569 $self->is_custom_shipto_to_delete(1);
1571 my $custom_shipto = $order->custom_shipto || $order->custom_shipto(SL::DB::Shipto->new(module => 'OE', custom_variables => []));
1573 my $shipto_cvars = {map { my ($key) = m{^shiptocvar_(.+)}; $key => delete $form->{$_}} grep { m{^shiptocvar_} } keys %$form};
1574 my $shipto_attrs = {map { $_ => delete $form->{$_}} grep { m{^shipto} } keys %$form};
1576 $custom_shipto->assign_attributes(%$shipto_attrs);
1577 $custom_shipto->cvar_by_name($_)->value($shipto_cvars->{$_}) for keys %$shipto_cvars;
1581 # recalculate prices and taxes
1583 # Using the PriceTaxCalculator. Store linetotals in the item objects.
1587 my %pat = $self->order->calculate_prices_and_taxes();
1589 $self->{taxes} = [];
1590 foreach my $tax_id (keys %{ $pat{taxes_by_tax_id} }) {
1591 my $netamount = sum0 map { $pat{amounts}->{$_}->{amount} } grep { $pat{amounts}->{$_}->{tax_id} == $tax_id } keys %{ $pat{amounts} };
1593 push(@{ $self->{taxes} }, { amount => $pat{taxes_by_tax_id}->{$tax_id},
1594 netamount => $netamount,
1595 tax => SL::DB::Tax->new(id => $tax_id)->load });
1597 pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items_sorted}, @{$pat{items}};
1600 # get data for saving, printing, ..., that is not changed in the form
1602 # Only cvars for now.
1603 sub get_unalterable_data {
1606 foreach my $item (@{ $self->order->items }) {
1607 # autovivify all cvars that are not in the form (cvars_by_config can do it).
1608 # workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
1609 foreach my $var (@{ $item->cvars_by_config }) {
1610 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
1612 $item->parse_custom_variable_values;
1618 # And remove related files in the spool directory
1623 my $db = $self->order->db;
1625 $db->with_transaction(
1627 my @spoolfiles = grep { $_ } map { $_->spoolfile } @{ SL::DB::Manager::Status->get_all(where => [ trans_id => $self->order->id ]) };
1628 $self->order->delete;
1629 my $spool = $::lx_office_conf{paths}->{spool};
1630 unlink map { "$spool/$_" } @spoolfiles if $spool;
1633 }) || push(@{$errors}, $db->error);
1640 # And delete items that are deleted in the form.
1645 my $db = $self->order->db;
1647 $db->with_transaction(sub {
1648 # delete custom shipto if it is to be deleted or if it is empty
1649 if ($self->order->custom_shipto && ($self->is_custom_shipto_to_delete || $self->order->custom_shipto->is_empty)) {
1650 $self->order->custom_shipto->delete if $self->order->custom_shipto->shipto_id;
1651 $self->order->custom_shipto(undef);
1654 SL::DB::OrderItem->new(id => $_)->delete for @{$self->item_ids_to_delete || []};
1655 $self->order->save(cascade => 1);
1658 if ($::form->{converted_from_oe_id}) {
1659 my @converted_from_oe_ids = split ' ', $::form->{converted_from_oe_id};
1660 foreach my $converted_from_oe_id (@converted_from_oe_ids) {
1661 my $src = SL::DB::Order->new(id => $converted_from_oe_id)->load;
1662 $src->update_attributes(closed => 1) if $src->type =~ /_quotation$/;
1663 $src->link_to_record($self->order);
1665 if (scalar @{ $::form->{converted_from_orderitems_ids} || [] }) {
1667 foreach (@{ $self->order->items_sorted }) {
1668 my $from_id = $::form->{converted_from_orderitems_ids}->[$idx];
1670 SL::DB::RecordLink->new(from_table => 'orderitems',
1671 from_id => $from_id,
1672 to_table => 'orderitems',
1680 }) || push(@{$errors}, $db->error);
1685 sub workflow_sales_or_purchase_order {
1689 my $errors = $self->save();
1691 if (scalar @{ $errors }) {
1692 $self->js->flash('error', $_) foreach @{ $errors };
1693 return $self->js->render();
1696 my $destination_type = $::form->{type} eq sales_quotation_type() ? sales_order_type()
1697 : $::form->{type} eq request_quotation_type() ? purchase_order_type()
1698 : $::form->{type} eq purchase_order_type() ? sales_order_type()
1699 : $::form->{type} eq sales_order_type() ? purchase_order_type()
1702 # check for direct delivery
1703 # copy shipto in custom shipto (custom shipto will be copied by new_from() in case)
1705 if ( $::form->{type} eq sales_order_type() && $destination_type eq purchase_order_type()
1706 && $::form->{use_shipto} && $self->order->shipto) {
1707 $custom_shipto = $self->order->shipto->clone('SL::DB::Order');
1710 $self->order(SL::DB::Order->new_from($self->order, destination_type => $destination_type));
1711 $self->{converted_from_oe_id} = delete $::form->{id};
1713 # set item ids to new fake id, to identify them as new items
1714 foreach my $item (@{$self->order->items_sorted}) {
1715 $item->{new_fake_id} = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
1718 if ($::form->{type} eq sales_order_type() && $destination_type eq purchase_order_type()) {
1719 if ($::form->{use_shipto}) {
1720 $self->order->custom_shipto($custom_shipto) if $custom_shipto;
1722 # remove any custom shipto if not wanted
1723 $self->order->custom_shipto(SL::DB::Shipto->new(module => 'OE', custom_variables => []));
1728 $::form->{type} = $destination_type;
1729 $self->type($self->init_type);
1730 $self->cv ($self->init_cv);
1734 $self->get_unalterable_data();
1735 $self->pre_render();
1737 # trigger rendering values for second row/longdescription as hidden,
1738 # because they are loaded only on demand. So we need to keep the values
1740 $_->{render_second_row} = 1 for @{ $self->order->items_sorted };
1741 $_->{render_longdescription} = 1 for @{ $self->order->items_sorted };
1745 title => $self->get_title_for('edit'),
1746 %{$self->{template_args}}
1754 $self->{all_taxzones} = SL::DB::Manager::TaxZone->get_all_sorted();
1755 $self->{all_currencies} = SL::DB::Manager::Currency->get_all_sorted();
1756 $self->{all_departments} = SL::DB::Manager::Department->get_all_sorted();
1757 $self->{all_languages} = SL::DB::Manager::Language->get_all_sorted();
1758 $self->{all_employees} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->employee_id,
1761 $self->{all_salesmen} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->salesman_id,
1764 $self->{all_payment_terms} = SL::DB::Manager::PaymentTerm->get_all_sorted(where => [ or => [ id => $self->order->payment_id,
1766 $self->{all_delivery_terms} = SL::DB::Manager::DeliveryTerm->get_all_sorted();
1767 $self->{current_employee_id} = SL::DB::Manager::Employee->current->id;
1768 $self->{periodic_invoices_status} = $self->get_periodic_invoices_status($self->order->periodic_invoices_config);
1769 $self->{order_probabilities} = [ map { { title => ($_ * 10) . '%', id => $_ * 10 } } (0..10) ];
1770 $self->{positions_scrollbar_height} = SL::Helper::UserPreferences::PositionsScrollbar->new()->get_height();
1772 my $print_form = Form->new('');
1773 $print_form->{type} = $self->type;
1774 $print_form->{printers} = SL::DB::Manager::Printer->get_all_sorted;
1775 $self->{print_options} = SL::Helper::PrintOptions->get_print_options(
1776 form => $print_form,
1777 options => {dialog_name_prefix => 'print_options.',
1781 no_opendocument => 0,
1785 foreach my $item (@{$self->order->orderitems}) {
1786 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
1787 $item->active_price_source( $price_source->price_from_source( $item->active_price_source ));
1788 $item->active_discount_source($price_source->discount_from_source($item->active_discount_source));
1791 if (any { $self->type eq $_ } (sales_order_type(), purchase_order_type())) {
1792 # calculate shipped qtys here to prevent calling calculate for every item via the items method
1793 SL::Helper::ShippedQty->new->calculate($self->order)->write_to_objects;
1796 if ($self->order->number && $::instance_conf->get_webdav) {
1797 my $webdav = SL::Webdav->new(
1798 type => $self->type,
1799 number => $self->order->number,
1801 my @all_objects = $webdav->get_all_objects;
1802 @{ $self->{template_args}->{WEBDAV} } = map { { name => $_->filename,
1804 link => File::Spec->catfile($_->full_filedescriptor),
1808 $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
1810 $::request->{layout}->use_javascript("${_}.js") for qw(kivi.SalesPurchase kivi.Order kivi.File ckeditor/ckeditor ckeditor/adapters/jquery
1811 edit_periodic_invoices_config calculate_qty kivi.Validator follow_up);
1812 $self->setup_edit_action_bar;
1815 sub setup_edit_action_bar {
1816 my ($self, %params) = @_;
1818 my $deletion_allowed = (any { $self->type eq $_ } (sales_quotation_type(), request_quotation_type()))
1819 || (($self->type eq sales_order_type()) && $::instance_conf->get_sales_order_show_delete)
1820 || (($self->type eq purchase_order_type()) && $::instance_conf->get_purchase_order_show_delete);
1822 for my $bar ($::request->layout->get('actionbar')) {
1827 call => [ 'kivi.Order.save', 'save', $::instance_conf->get_order_warn_duplicate_parts,
1828 $::instance_conf->get_order_warn_no_deliverydate,
1830 checks => [ 'kivi.Order.check_save_active_periodic_invoices', ['kivi.validate_form','#order_form'] ],
1834 call => [ 'kivi.Order.save', 'save_as_new', $::instance_conf->get_order_warn_duplicate_parts ],
1835 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1836 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1838 ], # end of combobox "Save"
1845 t8('Save and Sales Order'),
1846 submit => [ '#order_form', { action => "Order/sales_order" } ],
1847 only_if => (any { $self->type eq $_ } (sales_quotation_type(), purchase_order_type())),
1850 t8('Save and Purchase Order'),
1851 call => [ 'kivi.Order.purchase_order_check_for_direct_delivery' ],
1852 only_if => (any { $self->type eq $_ } (sales_order_type(), request_quotation_type())),
1855 t8('Save and Delivery Order'),
1856 call => [ 'kivi.Order.save', 'save_and_delivery_order', $::instance_conf->get_order_warn_duplicate_parts,
1857 $::instance_conf->get_order_warn_no_deliverydate,
1859 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1860 only_if => (any { $self->type eq $_ } (sales_order_type(), purchase_order_type()))
1863 t8('Save and Invoice'),
1864 call => [ 'kivi.Order.save', 'save_and_invoice', $::instance_conf->get_order_warn_duplicate_parts ],
1865 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1868 t8('Save and AP Transaction'),
1869 call => [ 'kivi.Order.save', 'save_and_ap_transaction', $::instance_conf->get_order_warn_duplicate_parts ],
1870 only_if => (any { $self->type eq $_ } (purchase_order_type()))
1873 ], # end of combobox "Workflow"
1880 t8('Save and print'),
1881 call => [ 'kivi.Order.show_print_options', $::instance_conf->get_order_warn_duplicate_parts ],
1884 t8('Save and E-mail'),
1885 call => [ 'kivi.Order.save', 'save_and_show_email_dialog', $::instance_conf->get_order_warn_duplicate_parts ],
1886 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1889 t8('Download attachments of all parts'),
1890 call => [ 'kivi.File.downloadOrderitemsFiles', $::form->{type}, $::form->{id} ],
1891 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1892 only_if => $::instance_conf->get_doc_storage,
1894 ], # end of combobox "Export"
1898 call => [ 'kivi.Order.delete_order' ],
1899 confirm => $::locale->text('Do you really want to delete this object?'),
1900 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1901 only_if => $deletion_allowed,
1910 call => [ 'kivi.Order.follow_up_window' ],
1911 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1912 only_if => $::auth->assert('productivity', 1),
1914 ], # end of combobox "more"
1920 my ($order, $pdf_ref, $params) = @_;
1924 my $print_form = Form->new('');
1925 $print_form->{type} = $order->type;
1926 $print_form->{formname} = $params->{formname} || $order->type;
1927 $print_form->{format} = $params->{format} || 'pdf';
1928 $print_form->{media} = $params->{media} || 'file';
1929 $print_form->{groupitems} = $params->{groupitems};
1930 $print_form->{media} = 'file' if $print_form->{media} eq 'screen';
1932 $order->language($params->{language});
1933 $order->flatten_to_form($print_form, format_amounts => 1);
1937 if ($print_form->{format} =~ /(opendocument|oasis)/i) {
1938 $template_ext = 'odt';
1939 $template_type = 'OpenDocument';
1942 # search for the template
1943 my ($template_file, @template_files) = SL::Helper::CreatePDF->find_template(
1944 name => $print_form->{formname},
1945 extension => $template_ext,
1946 email => $print_form->{media} eq 'email',
1947 language => $params->{language},
1948 printer_id => $print_form->{printer_id}, # todo
1951 if (!defined $template_file) {
1952 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);
1955 return @errors if scalar @errors;
1957 $print_form->throw_on_error(sub {
1959 $print_form->prepare_for_printing;
1961 $$pdf_ref = SL::Helper::CreatePDF->create_pdf(
1962 format => $print_form->{format},
1963 template_type => $template_type,
1964 template => $template_file,
1965 variables => $print_form,
1966 variable_content_types => {
1967 longdescription => 'html',
1968 partnotes => 'html',
1973 } || push @errors, ref($EVAL_ERROR) eq 'SL::X::FormError' ? $EVAL_ERROR->error : $EVAL_ERROR;
1979 sub get_files_for_email_dialog {
1982 my %files = map { ($_ => []) } qw(versions files vc_files part_files);
1984 return %files if !$::instance_conf->get_doc_storage;
1986 if ($self->order->id) {
1987 $files{versions} = [ SL::File->get_all_versions(object_id => $self->order->id, object_type => $self->order->type, file_type => 'document') ];
1988 $files{files} = [ SL::File->get_all( object_id => $self->order->id, object_type => $self->order->type, file_type => 'attachment') ];
1989 $files{vc_files} = [ SL::File->get_all( object_id => $self->order->{$self->cv}->id, object_type => $self->cv, file_type => 'attachment') ];
1993 uniq_by { $_->{id} }
1995 +{ id => $_->part->id,
1996 partnumber => $_->part->partnumber }
1997 } @{$self->order->items_sorted};
1999 foreach my $part (@parts) {
2000 my @pfiles = SL::File->get_all(object_id => $part->{id}, object_type => 'part');
2001 push @{ $files{part_files} }, map { +{ %{ $_ }, partnumber => $part->{partnumber} } } @pfiles;
2004 foreach my $key (keys %files) {
2005 $files{$key} = [ sort_by { lc $_->{db_file}->{file_name} } @{ $files{$key} } ];
2011 sub make_periodic_invoices_config_from_yaml {
2012 my ($yaml_config) = @_;
2014 return if !$yaml_config;
2015 my $attr = SL::YAML::Load($yaml_config);
2016 return if 'HASH' ne ref $attr;
2017 return SL::DB::PeriodicInvoicesConfig->new(%$attr);
2021 sub get_periodic_invoices_status {
2022 my ($self, $config) = @_;
2024 return if $self->type ne sales_order_type();
2025 return t8('not configured') if !$config;
2027 my $active = ('HASH' eq ref $config) ? $config->{active}
2028 : ('SL::DB::PeriodicInvoicesConfig' eq ref $config) ? $config->active
2029 : die "Cannot get status of periodic invoices config";
2031 return $active ? t8('active') : t8('inactive');
2035 my ($self, $action) = @_;
2037 return '' if none { lc($action)} qw(add edit);
2040 # $::locale->text("Add Sales Order");
2041 # $::locale->text("Add Purchase Order");
2042 # $::locale->text("Add Quotation");
2043 # $::locale->text("Add Request for Quotation");
2044 # $::locale->text("Edit Sales Order");
2045 # $::locale->text("Edit Purchase Order");
2046 # $::locale->text("Edit Quotation");
2047 # $::locale->text("Edit Request for Quotation");
2049 $action = ucfirst(lc($action));
2050 return $self->type eq sales_order_type() ? $::locale->text("$action Sales Order")
2051 : $self->type eq purchase_order_type() ? $::locale->text("$action Purchase Order")
2052 : $self->type eq sales_quotation_type() ? $::locale->text("$action Quotation")
2053 : $self->type eq request_quotation_type() ? $::locale->text("$action Request for Quotation")
2057 sub get_item_cvpartnumber {
2058 my ($self, $item) = @_;
2060 return if !$self->search_cvpartnumber;
2061 return if !$self->order->customervendor;
2063 if ($self->cv eq 'vendor') {
2064 my @mms = grep { $_->make eq $self->order->customervendor->id } @{$item->part->makemodels};
2065 $item->{cvpartnumber} = $mms[0]->model if scalar @mms;
2066 } elsif ($self->cv eq 'customer') {
2067 my @cps = grep { $_->customer_id eq $self->order->customervendor->id } @{$item->part->customerprices};
2068 $item->{cvpartnumber} = $cps[0]->customer_partnumber if scalar @cps;
2072 sub sales_order_type {
2076 sub purchase_order_type {
2080 sub sales_quotation_type {
2084 sub request_quotation_type {
2085 'request_quotation';
2089 return $_[0]->type eq sales_order_type() ? 'ordnumber'
2090 : $_[0]->type eq purchase_order_type() ? 'ordnumber'
2091 : $_[0]->type eq sales_quotation_type() ? 'quonumber'
2092 : $_[0]->type eq request_quotation_type() ? 'quonumber'
2104 SL::Controller::Order - controller for orders
2108 This is a new form to enter orders, completely rewritten with the use
2109 of controller and java script techniques.
2111 The aim is to provide the user a better experience and a faster workflow. Also
2112 the code should be more readable, more reliable and better to maintain.
2120 One input row, so that input happens every time at the same place.
2124 Use of pickers where possible.
2128 Possibility to enter more than one item at once.
2132 Item list in a scrollable area, so that the workflow buttons stay at
2137 Reordering item rows with drag and drop is possible. Sorting item rows is
2138 possible (by partnumber, description, qty, sellprice and discount for now).
2142 No C<update> is necessary. All entries and calculations are managed
2143 with ajax-calls and the page only reloads on C<save>.
2147 User can see changes immediately, because of the use of java script
2158 =item * C<SL/Controller/Order.pm>
2162 =item * C<template/webpages/order/form.html>
2166 =item * C<template/webpages/order/tabs/basic_data.html>
2168 Main tab for basic_data.
2170 This is the only tab here for now. "linked records" and "webdav" tabs are
2171 reused from generic code.
2175 =item * C<template/webpages/order/tabs/_business_info_row.html>
2177 For displaying information on business type
2179 =item * C<template/webpages/order/tabs/_item_input.html>
2181 The input line for items
2183 =item * C<template/webpages/order/tabs/_row.html>
2185 One row for already entered items
2187 =item * C<template/webpages/order/tabs/_tax_row.html>
2189 Displaying tax information
2191 =item * C<template/webpages/order/tabs/_multi_items_dialog.html>
2193 Dialog for entering more than one item at once
2195 =item * C<template/webpages/order/tabs/_multi_items_result.html>
2197 Results for the filter in the multi items dialog
2199 =item * C<template/webpages/order/tabs/_price_sources_dialog.html>
2201 Dialog for selecting price and discount sources
2205 =item * C<js/kivi.Order.js>
2207 java script functions
2217 =item * credit limit
2219 =item * more workflows (quotation, rfq)
2221 =item * price sources: little symbols showing better price / better discount
2223 =item * select units in input row?
2225 =item * check for direct delivery (workflow sales order -> purchase order)
2227 =item * language / part translations
2229 =item * access rights
2231 =item * display weights
2237 =item * optional client/user behaviour
2239 (transactions has to be set - department has to be set -
2240 force project if enabled in client config - transport cost reminder)
2244 =head1 KNOWN BUGS AND CAVEATS
2250 Customer discount is not displayed as a valid discount in price source popup
2251 (this might be a bug in price sources)
2253 (I cannot reproduce this (Bernd))
2257 No indication that <shift>-up/down expands/collapses second row.
2261 Inline creation of parts is not currently supported
2265 Table header is not sticky in the scrolling area.
2269 Sorting does not include C<position>, neither does reordering.
2271 This behavior was implemented intentionally. But we can discuss, which behavior
2272 should be implemented.
2276 C<show_multi_items_dialog> does not use the currently inserted string for
2281 =head1 To discuss / Nice to have
2287 How to expand/collapse second row. Now it can be done clicking the icon or
2292 Possibility to change longdescription in input row?
2296 Possibility to select PriceSources in input row?
2300 This controller uses a (changed) copy of the template for the PriceSource
2301 dialog. Maybe there could be used one code source.
2305 Rounding-differences between this controller (PriceTaxCalculator) and the old
2306 form. This is not only a problem here, but also in all parts using the PTC.
2307 There exists a ticket and a patch. This patch should be testet.
2311 An indicator, if the actual inputs are saved (like in an
2312 editor or on text processing application).
2316 A warning when leaving the page without saveing unchanged inputs.
2323 Bernd Bleßmann E<lt>bernd@kivitendo-premium.deE<gt>