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;
30 use SL::Controller::Helper::GetModels;
32 use List::Util qw(first);
33 use List::UtilsBy qw(sort_by uniq_by);
34 use List::MoreUtils qw(any none pairwise first_index);
35 use English qw(-no_match_vars);
40 use Rose::Object::MakeMethods::Generic
42 scalar => [ qw(item_ids_to_delete) ],
43 'scalar --get_set_init' => [ qw(order valid_types type cv p multi_items_models all_price_factors search_cvpartnumber) ],
48 __PACKAGE__->run_before('check_auth');
50 __PACKAGE__->run_before('recalc',
51 only => [ qw(save save_as_new save_and_delivery_order save_and_invoice save_and_ap_transaction
54 __PACKAGE__->run_before('get_unalterable_data',
55 only => [ qw(save save_as_new save_and_delivery_order save_and_invoice save_and_ap_transaction
66 $self->order->transdate(DateTime->now_local());
67 my $extra_days = $self->{type} eq 'sales_quotation' ? $::instance_conf->get_reqdate_interval :
68 $self->{type} eq 'sales_order' ? $::instance_conf->get_delivery_date_interval : 1;
69 $self->order->reqdate(DateTime->today_local->next_workday(extra_days => $extra_days)) if !$self->order->reqdate;
75 title => $self->get_title_for('add'),
76 %{$self->{template_args}}
80 # edit an existing order
88 # this is to edit an order from an unsaved order object
90 # set item ids to new fake id, to identify them as new items
91 foreach my $item (@{$self->order->items_sorted}) {
92 $item->{new_fake_id} = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
94 # trigger rendering values for second row/longdescription as hidden,
95 # because they are loaded only on demand. So we need to keep the values
97 $_->{render_second_row} = 1 for @{ $self->order->items_sorted };
98 $_->{render_longdescription} = 1 for @{ $self->order->items_sorted };
105 title => $self->get_title_for('edit'),
106 %{$self->{template_args}}
110 # edit a collective order (consisting of one or more existing orders)
111 sub action_edit_collective {
115 my @multi_ids = map {
116 $_ =~ m{^multi_id_(\d+)$} && $::form->{'multi_id_' . $1} && $::form->{'trans_id_' . $1} && $::form->{'trans_id_' . $1}
117 } grep { $_ =~ m{^multi_id_\d+$} } keys %$::form;
119 # fall back to add if no ids are given
120 if (scalar @multi_ids == 0) {
125 # fall back to save as new if only one id is given
126 if (scalar @multi_ids == 1) {
127 $self->order(SL::DB::Order->new(id => $multi_ids[0])->load);
128 $self->action_save_as_new();
132 # make new order from given orders
133 my @multi_orders = map { SL::DB::Order->new(id => $_)->load } @multi_ids;
134 $self->{converted_from_oe_id} = join ' ', map { $_->id } @multi_orders;
135 $self->order(SL::DB::Order->new_from_multi(\@multi_orders, sort_sources_by => 'transdate'));
137 $self->action_edit();
144 my $errors = $self->delete();
146 if (scalar @{ $errors }) {
147 $self->js->flash('error', $_) foreach @{ $errors };
148 return $self->js->render();
151 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been deleted')
152 : $self->type eq purchase_order_type() ? $::locale->text('The order has been deleted')
153 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been deleted')
154 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been deleted')
156 flash_later('info', $text);
158 my @redirect_params = (
163 $self->redirect_to(@redirect_params);
170 my $errors = $self->save();
172 if (scalar @{ $errors }) {
173 $self->js->flash('error', $_) foreach @{ $errors };
174 return $self->js->render();
177 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
178 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
179 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
180 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
182 flash_later('info', $text);
184 my @redirect_params = (
187 id => $self->order->id,
190 $self->redirect_to(@redirect_params);
193 # save the order as new document an open it for edit
194 sub action_save_as_new {
197 my $order = $self->order;
200 $self->js->flash('error', t8('This object has not been saved yet.'));
201 return $self->js->render();
204 # load order from db to check if values changed
205 my $saved_order = SL::DB::Order->new(id => $order->id)->load;
208 # Lets assign a new number if the user hasn't changed the previous one.
209 # If it has been changed manually then use it as-is.
210 $new_attrs{number} = (trim($order->number) eq $saved_order->number)
212 : trim($order->number);
214 # Clear transdate unless changed
215 $new_attrs{transdate} = ($order->transdate == $saved_order->transdate)
216 ? DateTime->today_local
219 # Set new reqdate unless changed
220 if ($order->reqdate == $saved_order->reqdate) {
221 my $extra_days = $self->{type} eq 'sales_quotation' ? $::instance_conf->get_reqdate_interval :
222 $self->{type} eq 'sales_order' ? $::instance_conf->get_delivery_date_interval : 1;
223 $new_attrs{reqdate} = DateTime->today_local->next_workday(extra_days => $extra_days);
225 $new_attrs{reqdate} = $order->reqdate;
229 $new_attrs{employee} = SL::DB::Manager::Employee->current;
231 # Create new record from current one
232 $self->order(SL::DB::Order->new_from($order, destination_type => $order->type, attributes => \%new_attrs));
234 # no linked records on save as new
235 delete $::form->{$_} for qw(converted_from_oe_id converted_from_orderitems_ids);
238 $self->action_save();
243 # This is called if "print" is pressed in the print dialog.
244 # If PDF creation was requested and succeeded, the pdf is stored in a session
245 # file and the filename is stored as session value with an unique key. A
246 # javascript function with this key is then called. This function calls the
247 # download action below (action_download_pdf), which offers the file for
252 my $errors = $self->save();
254 if (scalar @{ $errors }) {
255 $self->js->flash('error', $_) foreach @{ $errors };
256 return $self->js->render();
259 $self->js_reset_order_and_item_ids_after_save;
261 my $format = $::form->{print_options}->{format};
262 my $media = $::form->{print_options}->{media};
263 my $formname = $::form->{print_options}->{formname};
264 my $copies = $::form->{print_options}->{copies};
265 my $groupitems = $::form->{print_options}->{groupitems};
267 # only pdf and opendocument by now
268 if (none { $format eq $_ } qw(pdf opendocument opendocument_pdf)) {
269 return $self->js->flash('error', t8('Format \'#1\' is not supported yet/anymore.', $format))->render;
272 # only screen or printer by now
273 if (none { $media eq $_ } qw(screen printer)) {
274 return $self->js->flash('error', t8('Media \'#1\' is not supported yet/anymore.', $media))->render;
278 $language = SL::DB::Language->new(id => $::form->{print_options}->{language_id})->load if $::form->{print_options}->{language_id};
280 # create a form for generate_attachment_filename
281 my $form = Form->new;
282 $form->{$self->nr_key()} = $self->order->number;
283 $form->{type} = $self->type;
284 $form->{format} = $format;
285 $form->{formname} = $formname;
286 $form->{language} = '_' . $language->template_code if $language;
287 my $pdf_filename = $form->generate_attachment_filename();
290 my @errors = generate_pdf($self->order, \$pdf, { format => $format,
291 formname => $formname,
292 language => $language,
293 groupitems => $groupitems });
294 if (scalar @errors) {
295 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render;
298 if ($media eq 'screen') {
300 my $sfile = SL::SessionFile::Random->new(mode => "w");
301 $sfile->fh->print($pdf);
304 my $key = join('_', Time::HiRes::gettimeofday(), int rand 1000000000000);
305 $::auth->set_session_value("Order::print-${key}" => $sfile->file_name);
308 ->run('kivi.Order.download_pdf', $pdf_filename, $key)
309 ->flash('info', t8('The PDF has been created'));
311 } elsif ($media eq 'printer') {
313 my $printer_id = $::form->{print_options}->{printer_id};
314 SL::DB::Printer->new(id => $printer_id)->load->print_document(
319 $self->js->flash('info', t8('The PDF has been printed'));
322 # copy file to webdav folder
323 if ($self->order->number && $::instance_conf->get_webdav_documents) {
324 my $webdav = SL::Webdav->new(
326 number => $self->order->number,
328 my $webdav_file = SL::Webdav::File->new(
330 filename => $pdf_filename,
333 $webdav_file->store(data => \$pdf);
336 $self->js->flash('error', t8('Storing PDF to webdav folder failed: #1', $@));
339 if ($self->order->number && $::instance_conf->get_doc_storage) {
341 SL::File->save(object_id => $self->order->id,
342 object_type => $self->type,
343 mime_type => 'application/pdf',
345 file_type => 'document',
346 file_name => $pdf_filename,
347 file_contents => $pdf);
350 $self->js->flash('error', t8('Storing PDF in storage backend failed: #1', $@));
356 # offer pdf for download
358 # It needs to get the key for the session value to get the pdf file.
359 sub action_download_pdf {
362 my $key = $::form->{key};
363 my $tmp_filename = $::auth->get_session_value("Order::print-${key}");
364 return $self->send_file(
366 type => SL::MIME->mime_type_from_ext($::form->{pdf_filename}),
367 name => $::form->{pdf_filename},
371 # open the email dialog
372 sub action_show_email_dialog {
375 my $cv_method = $self->cv;
377 if (!$self->order->$cv_method) {
378 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'))
383 $email_form->{to} = $self->order->contact->cp_email if $self->order->contact;
384 $email_form->{to} ||= $self->order->$cv_method->email;
385 $email_form->{cc} = $self->order->$cv_method->cc;
386 $email_form->{bcc} = join ', ', grep $_, $self->order->$cv_method->bcc, SL::DB::Default->get->global_bcc;
387 # Todo: get addresses from shipto, if any
389 my $form = Form->new;
390 $form->{$self->nr_key()} = $self->order->number;
391 $form->{formname} = $self->type;
392 $form->{type} = $self->type;
393 $form->{language} = 'de';
394 $form->{format} = 'pdf';
396 $email_form->{subject} = $form->generate_email_subject();
397 $email_form->{attachment_filename} = $form->generate_attachment_filename();
398 $email_form->{message} = $form->generate_email_body();
399 $email_form->{js_send_function} = 'kivi.Order.send_email()';
401 my %files = $self->get_files_for_email_dialog();
402 my $dialog_html = $self->render('common/_send_email_dialog', { output => 0 },
403 email_form => $email_form,
404 show_bcc => $::auth->assert('email_bcc', 'may fail'),
406 is_customer => $self->cv eq 'customer',
410 ->run('kivi.Order.show_email_dialog', $dialog_html)
417 # Todo: handling error messages: flash is not displayed in dialog, but in the main form
418 sub action_send_email {
421 my $errors = $self->save();
423 if (scalar @{ $errors }) {
424 $self->js->run('kivi.Order.close_email_dialog');
425 $self->js->flash('error', $_) foreach @{ $errors };
426 return $self->js->render();
429 $self->js_reset_order_and_item_ids_after_save;
431 my $email_form = delete $::form->{email_form};
432 my %field_names = (to => 'email');
434 $::form->{ $field_names{$_} // $_ } = $email_form->{$_} for keys %{ $email_form };
436 # for Form::cleanup which may be called in Form::send_email
437 $::form->{cwd} = getcwd();
438 $::form->{tmpdir} = $::lx_office_conf{paths}->{userspath};
440 $::form->{$_} = $::form->{print_options}->{$_} for keys %{ $::form->{print_options} };
441 $::form->{media} = 'email';
443 if (($::form->{attachment_policy} // '') !~ m{^(?:old_file|no_file)$}) {
445 $language = SL::DB::Language->new(id => $::form->{print_options}->{language_id})->load if $::form->{print_options}->{language_id};
448 my @errors = generate_pdf($self->order, \$pdf, {media => $::form->{media},
449 format => $::form->{print_options}->{format},
450 formname => $::form->{print_options}->{formname},
451 language => $language,
452 groupitems => $::form->{print_options}->{groupitems}});
453 if (scalar @errors) {
454 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
457 my $sfile = SL::SessionFile::Random->new(mode => "w");
458 $sfile->fh->print($pdf);
461 $::form->{tmpfile} = $sfile->file_name;
462 $::form->{tmpdir} = $sfile->get_path; # for Form::cleanup which may be called in Form::send_email
465 $::form->send_email(\%::myconfig, 'pdf');
468 my $intnotes = $self->order->intnotes;
469 $intnotes .= "\n\n" if $self->order->intnotes;
470 $intnotes .= t8('[email]') . "\n";
471 $intnotes .= t8('Date') . ": " . $::locale->format_date_object(DateTime->now_local, precision => 'seconds') . "\n";
472 $intnotes .= t8('To (email)') . ": " . $::form->{email} . "\n";
473 $intnotes .= t8('Cc') . ": " . $::form->{cc} . "\n" if $::form->{cc};
474 $intnotes .= t8('Bcc') . ": " . $::form->{bcc} . "\n" if $::form->{bcc};
475 $intnotes .= t8('Subject') . ": " . $::form->{subject} . "\n\n";
476 $intnotes .= t8('Message') . ": " . $::form->{message};
478 $self->order->update_attributes(intnotes => $intnotes);
481 ->val('#order_intnotes', $intnotes)
482 ->run('kivi.Order.close_email_dialog')
483 ->flash('info', t8('The email has been sent.'))
487 # open the periodic invoices config dialog
489 # If there are values in the form (i.e. dialog was opened before),
490 # then use this values. Create new ones, else.
491 sub action_show_periodic_invoices_config_dialog {
494 my $config = make_periodic_invoices_config_from_yaml(delete $::form->{config});
495 $config ||= SL::DB::Manager::PeriodicInvoicesConfig->find_by(oe_id => $::form->{id}) if $::form->{id};
496 $config ||= SL::DB::PeriodicInvoicesConfig->new(periodicity => 'm',
497 order_value_periodicity => 'p', # = same as periodicity
498 start_date_as_date => $::form->{transdate_as_date} || $::form->current_date,
499 extend_automatically_by => 12,
501 email_subject => GenericTranslations->get(
502 language_id => $::form->{language_id},
503 translation_type =>"preset_text_periodic_invoices_email_subject"),
504 email_body => GenericTranslations->get(
505 language_id => $::form->{language_id},
506 translation_type =>"preset_text_periodic_invoices_email_body"),
508 $config->periodicity('m') if none { $_ eq $config->periodicity } @SL::DB::PeriodicInvoicesConfig::PERIODICITIES;
509 $config->order_value_periodicity('p') if none { $_ eq $config->order_value_periodicity } ('p', @SL::DB::PeriodicInvoicesConfig::ORDER_VALUE_PERIODICITIES);
511 $::form->get_lists(printers => "ALL_PRINTERS",
512 charts => { key => 'ALL_CHARTS',
513 transdate => 'current_date' });
515 $::form->{AR} = [ grep { $_->{link} =~ m/(?:^|:)AR(?::|$)/ } @{ $::form->{ALL_CHARTS} } ];
517 if ($::form->{customer_id}) {
518 $::form->{ALL_CONTACTS} = SL::DB::Manager::Contact->get_all_sorted(where => [ cp_cv_id => $::form->{customer_id} ]);
519 $::form->{email_recipient_invoice_address} = SL::DB::Manager::Customer->find_by(id => $::form->{customer_id})->invoice_mail;
522 $self->render('oe/edit_periodic_invoices_config', { layout => 0 },
524 popup_js_close_function => 'kivi.Order.close_periodic_invoices_config_dialog()',
525 popup_js_assign_function => 'kivi.Order.assign_periodic_invoices_config()',
530 # assign the values of the periodic invoices config dialog
531 # as yaml in the hidden tag and set the status.
532 sub action_assign_periodic_invoices_config {
535 $::form->isblank('start_date_as_date', $::locale->text('The start date is missing.'));
537 my $config = { active => $::form->{active} ? 1 : 0,
538 terminated => $::form->{terminated} ? 1 : 0,
539 direct_debit => $::form->{direct_debit} ? 1 : 0,
540 periodicity => (any { $_ eq $::form->{periodicity} } @SL::DB::PeriodicInvoicesConfig::PERIODICITIES) ? $::form->{periodicity} : 'm',
541 order_value_periodicity => (any { $_ eq $::form->{order_value_periodicity} } ('p', @SL::DB::PeriodicInvoicesConfig::ORDER_VALUE_PERIODICITIES)) ? $::form->{order_value_periodicity} : 'p',
542 start_date_as_date => $::form->{start_date_as_date},
543 end_date_as_date => $::form->{end_date_as_date},
544 first_billing_date_as_date => $::form->{first_billing_date_as_date},
545 print => $::form->{print} ? 1 : 0,
546 printer_id => $::form->{print} ? $::form->{printer_id} * 1 : undef,
547 copies => $::form->{copies} * 1 ? $::form->{copies} : 1,
548 extend_automatically_by => $::form->{extend_automatically_by} * 1 || undef,
549 ar_chart_id => $::form->{ar_chart_id} * 1,
550 send_email => $::form->{send_email} ? 1 : 0,
551 email_recipient_contact_id => $::form->{email_recipient_contact_id} * 1 || undef,
552 email_recipient_address => $::form->{email_recipient_address},
553 email_sender => $::form->{email_sender},
554 email_subject => $::form->{email_subject},
555 email_body => $::form->{email_body},
558 my $periodic_invoices_config = SL::YAML::Dump($config);
560 my $status = $self->get_periodic_invoices_status($config);
563 ->remove('#order_periodic_invoices_config')
564 ->insertAfter(hidden_tag('order.periodic_invoices_config', $periodic_invoices_config), '#periodic_invoices_status')
565 ->run('kivi.Order.close_periodic_invoices_config_dialog')
566 ->html('#periodic_invoices_status', $status)
567 ->flash('info', t8('The periodic invoices config has been assigned.'))
571 sub action_get_has_active_periodic_invoices {
574 my $config = make_periodic_invoices_config_from_yaml(delete $::form->{config});
575 $config ||= SL::DB::Manager::PeriodicInvoicesConfig->find_by(oe_id => $::form->{id}) if $::form->{id};
577 my $has_active_periodic_invoices =
578 $self->type eq sales_order_type()
581 && (!$config->end_date || ($config->end_date > DateTime->today_local))
582 && $config->get_previous_billed_period_start_date;
584 $_[0]->render(\ !!$has_active_periodic_invoices, { type => 'text' });
587 # save the order and redirect to the frontend subroutine for a new
589 sub action_save_and_delivery_order {
592 my $errors = $self->save();
594 if (scalar @{ $errors }) {
595 $self->js->flash('error', $_) foreach @{ $errors };
596 return $self->js->render();
599 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
600 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
601 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
602 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
604 flash_later('info', $text);
606 my @redirect_params = (
607 controller => 'oe.pl',
608 action => 'oe_delivery_order_from_order',
609 id => $self->order->id,
612 $self->redirect_to(@redirect_params);
615 # save the order and redirect to the frontend subroutine for a new
617 sub action_save_and_invoice {
620 my $errors = $self->save();
622 if (scalar @{ $errors }) {
623 $self->js->flash('error', $_) foreach @{ $errors };
624 return $self->js->render();
627 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
628 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
629 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
630 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
632 flash_later('info', $text);
634 my @redirect_params = (
635 controller => 'oe.pl',
636 action => 'oe_invoice_from_order',
637 id => $self->order->id,
640 $self->redirect_to(@redirect_params);
643 # workflow from sales quotation to sales order
644 sub action_sales_order {
645 $_[0]->workflow_sales_or_purchase_order();
648 # workflow from rfq to purchase order
649 sub action_purchase_order {
650 $_[0]->workflow_sales_or_purchase_order();
653 # workflow from purchase order to ap transaction
654 sub action_save_and_ap_transaction {
657 my $errors = $self->save();
659 if (scalar @{ $errors }) {
660 $self->js->flash('error', $_) foreach @{ $errors };
661 return $self->js->render();
664 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
665 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
666 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
667 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
669 flash_later('info', $text);
671 my @redirect_params = (
672 controller => 'ap.pl',
673 action => 'add_from_purchase_order',
674 id => $self->order->id,
677 $self->redirect_to(@redirect_params);
680 # set form elements in respect to a changed customer or vendor
682 # This action is called on an change of the customer/vendor picker.
683 sub action_customer_vendor_changed {
686 setup_order_from_cv($self->order);
689 my $cv_method = $self->cv;
691 if ($self->order->$cv_method->contacts && scalar @{ $self->order->$cv_method->contacts } > 0) {
692 $self->js->show('#cp_row');
694 $self->js->hide('#cp_row');
697 if ($self->order->$cv_method->shipto && scalar @{ $self->order->$cv_method->shipto } > 0) {
698 $self->js->show('#shipto_row');
700 $self->js->hide('#shipto_row');
703 $self->js->val( '#order_salesman_id', $self->order->salesman_id) if $self->order->is_sales;
706 ->replaceWith('#order_cp_id', $self->build_contact_select)
707 ->replaceWith('#order_shipto_id', $self->build_shipto_select)
708 ->replaceWith('#business_info_row', $self->build_business_info_row)
709 ->val( '#order_taxzone_id', $self->order->taxzone_id)
710 ->val( '#order_taxincluded', $self->order->taxincluded)
711 ->val( '#order_payment_id', $self->order->payment_id)
712 ->val( '#order_delivery_term_id', $self->order->delivery_term_id)
713 ->val( '#order_intnotes', $self->order->intnotes)
714 ->val( '#language_id', $self->order->$cv_method->language_id)
715 ->focus( '#order_' . $self->cv . '_id');
717 $self->js_redisplay_amounts_and_taxes;
718 $self->js_redisplay_cvpartnumbers;
722 # open the dialog for customer/vendor details
723 sub action_show_customer_vendor_details_dialog {
726 my $is_customer = 'customer' eq $::form->{vc};
729 $cv = SL::DB::Customer->new(id => $::form->{vc_id})->load;
731 $cv = SL::DB::Vendor->new(id => $::form->{vc_id})->load;
734 my %details = map { $_ => $cv->$_ } @{$cv->meta->columns};
735 $details{discount_as_percent} = $cv->discount_as_percent;
736 $details{creditlimt} = $cv->creditlimit_as_number;
737 $details{business} = $cv->business->description if $cv->business;
738 $details{language} = $cv->language_obj->description if $cv->language_obj;
739 $details{delivery_terms} = $cv->delivery_term->description if $cv->delivery_term;
740 $details{payment_terms} = $cv->payment->description if $cv->payment;
741 $details{pricegroup} = $cv->pricegroup->pricegroup if $is_customer && $cv->pricegroup;
743 foreach my $entry (@{ $cv->shipto }) {
744 push @{ $details{SHIPTO} }, { map { $_ => $entry->$_ } @{$entry->meta->columns} };
746 foreach my $entry (@{ $cv->contacts }) {
747 push @{ $details{CONTACTS} }, { map { $_ => $entry->$_ } @{$entry->meta->columns} };
750 $_[0]->render('common/show_vc_details', { layout => 0 },
751 is_customer => $is_customer,
756 # called if a unit in an existing item row is changed
757 sub action_unit_changed {
760 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
761 my $item = $self->order->items_sorted->[$idx];
763 my $old_unit_obj = SL::DB::Unit->new(name => $::form->{old_unit})->load;
764 $item->sellprice($item->unit_obj->convert_to($item->sellprice, $old_unit_obj));
769 ->run('kivi.Order.update_sellprice', $::form->{item_id}, $item->sellprice_as_number);
770 $self->js_redisplay_line_values;
771 $self->js_redisplay_amounts_and_taxes;
775 # add an item row for a new item entered in the input row
776 sub action_add_item {
779 my $form_attr = $::form->{add_item};
781 return unless $form_attr->{parts_id};
783 my $item = new_item($self->order, $form_attr);
785 $self->order->add_items($item);
789 $self->get_item_cvpartnumber($item);
791 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
792 my $row_as_html = $self->p->render('order/tabs/_row',
796 ALL_PRICE_FACTORS => $self->all_price_factors,
797 SEARCH_CVPARTNUMBER => $self->search_cvpartnumber,
801 ->append('#row_table_id', $row_as_html);
803 if ( $item->part->is_assortment ) {
804 $form_attr->{qty_as_number} = 1 unless $form_attr->{qty_as_number};
805 foreach my $assortment_item ( @{$item->part->assortment_items} ) {
806 my $attr = { parts_id => $assortment_item->parts_id,
807 qty => $assortment_item->qty * $::form->parse_amount(\%::myconfig, $form_attr->{qty_as_number}), # TODO $form_attr->{unit}
808 unit => $assortment_item->unit,
809 description => $assortment_item->part->description,
811 my $item = new_item($self->order, $attr);
813 # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount
814 $item->discount(1) unless $assortment_item->charge;
816 $self->order->add_items( $item );
818 $self->get_item_cvpartnumber($item);
819 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
820 my $row_as_html = $self->p->render('order/tabs/_row',
824 ALL_PRICE_FACTORS => $self->all_price_factors,
825 SEARCH_CVPARTNUMBER => $self->search_cvpartnumber,
828 ->append('#row_table_id', $row_as_html);
833 ->val('.add_item_input', '')
834 ->run('kivi.Order.init_row_handlers')
835 ->run('kivi.Order.row_table_scroll_down')
836 ->run('kivi.Order.renumber_positions')
837 ->focus('#add_item_parts_id_name');
839 $self->js_redisplay_amounts_and_taxes;
843 # open the dialog for entering multiple items at once
844 sub action_show_multi_items_dialog {
845 $_[0]->render('order/tabs/_multi_items_dialog', { layout => 0 },
846 all_partsgroups => SL::DB::Manager::PartsGroup->get_all);
849 # update the filter results in the multi item dialog
850 sub action_multi_items_update_result {
853 $::form->{multi_items}->{filter}->{obsolete} = 0;
855 my $count = $_[0]->multi_items_models->count;
858 my $text = SL::Presenter::EscapedText->new(text => $::locale->text('No results.'));
859 $_[0]->render($text, { layout => 0 });
860 } elsif ($count > $max_count) {
861 my $text = SL::Presenter::EscapedText->new(text => $::locale->text('Too many results (#1 from #2).', $count, $max_count));
862 $_[0]->render($text, { layout => 0 });
864 my $multi_items = $_[0]->multi_items_models->get;
865 $_[0]->render('order/tabs/_multi_items_result', { layout => 0 },
866 multi_items => $multi_items);
870 # add item rows for multiple items at once
871 sub action_add_multi_items {
874 my @form_attr = grep { $_->{qty_as_number} } @{ $::form->{add_multi_items} };
875 return $self->js->render() unless scalar @form_attr;
878 foreach my $attr (@form_attr) {
879 my $item = new_item($self->order, $attr);
881 if ( $item->part->is_assortment ) {
882 foreach my $assortment_item ( @{$item->part->assortment_items} ) {
883 my $attr = { parts_id => $assortment_item->parts_id,
884 qty => $assortment_item->qty * $item->qty, # TODO $form_attr->{unit}
885 unit => $assortment_item->unit,
886 description => $assortment_item->part->description,
888 my $item = new_item($self->order, $attr);
890 # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount
891 $item->discount(1) unless $assortment_item->charge;
896 $self->order->add_items(@items);
900 foreach my $item (@items) {
901 $self->get_item_cvpartnumber($item);
902 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
903 my $row_as_html = $self->p->render('order/tabs/_row',
907 ALL_PRICE_FACTORS => $self->all_price_factors,
908 SEARCH_CVPARTNUMBER => $self->search_cvpartnumber,
911 $self->js->append('#row_table_id', $row_as_html);
915 ->run('kivi.Order.close_multi_items_dialog')
916 ->run('kivi.Order.init_row_handlers')
917 ->run('kivi.Order.row_table_scroll_down')
918 ->run('kivi.Order.renumber_positions')
919 ->focus('#add_item_parts_id_name');
921 $self->js_redisplay_amounts_and_taxes;
925 # recalculate all linetotals, amounts and taxes and redisplay them
926 sub action_recalc_amounts_and_taxes {
931 $self->js_redisplay_line_values;
932 $self->js_redisplay_amounts_and_taxes;
936 # redisplay item rows if they are sorted by an attribute
937 sub action_reorder_items {
941 partnumber => sub { $_[0]->part->partnumber },
942 description => sub { $_[0]->description },
943 qty => sub { $_[0]->qty },
944 sellprice => sub { $_[0]->sellprice },
945 discount => sub { $_[0]->discount },
946 cvpartnumber => sub { $_[0]->{cvpartnumber} },
949 $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
951 my $method = $sort_keys{$::form->{order_by}};
952 my @to_sort = map { { old_pos => $_->position, order_by => $method->($_) } } @{ $self->order->items_sorted };
953 if ($::form->{sort_dir}) {
954 if ( $::form->{order_by} =~ m/qty|sellprice|discount/ ){
955 @to_sort = sort { $a->{order_by} <=> $b->{order_by} } @to_sort;
957 @to_sort = sort { $a->{order_by} cmp $b->{order_by} } @to_sort;
960 if ( $::form->{order_by} =~ m/qty|sellprice|discount/ ){
961 @to_sort = sort { $b->{order_by} <=> $a->{order_by} } @to_sort;
963 @to_sort = sort { $b->{order_by} cmp $a->{order_by} } @to_sort;
967 ->run('kivi.Order.redisplay_items', \@to_sort)
971 # show the popup to choose a price/discount source
972 sub action_price_popup {
975 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
976 my $item = $self->order->items_sorted->[$idx];
978 $self->render_price_dialog($item);
981 # get the longdescription for an item if the dialog to enter/change the
982 # longdescription was opened and the longdescription is empty
984 # If this item is new, get the longdescription from Part.
985 # Otherwise get it from OrderItem.
986 sub action_get_item_longdescription {
989 if ($::form->{item_id}) {
990 $longdescription = SL::DB::OrderItem->new(id => $::form->{item_id})->load->longdescription;
991 } elsif ($::form->{parts_id}) {
992 $longdescription = SL::DB::Part->new(id => $::form->{parts_id})->load->notes;
994 $_[0]->render(\ $longdescription, { type => 'text' });
997 # load the second row for one or more items
999 # This action gets the html code for all items second rows by rendering a template for
1000 # the second row and sets the html code via client js.
1001 sub action_load_second_rows {
1004 $self->recalc() if $self->order->is_sales; # for margin calculation
1006 foreach my $item_id (@{ $::form->{item_ids} }) {
1007 my $idx = first_index { $_ eq $item_id } @{ $::form->{orderitem_ids} };
1008 my $item = $self->order->items_sorted->[$idx];
1010 $self->js_load_second_row($item, $item_id, 0);
1013 $self->js->run('kivi.Order.init_row_handlers') if $self->order->is_sales; # for lastcosts change-callback
1015 $self->js->render();
1018 sub js_load_second_row {
1019 my ($self, $item, $item_id, $do_parse) = @_;
1022 # Parse values from form (they are formated while rendering (template)).
1023 # Workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
1024 # This parsing is not necessary at all, if we assure that the second row/cvars are only loaded once.
1025 foreach my $var (@{ $item->cvars_by_config }) {
1026 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
1028 $item->parse_custom_variable_values;
1031 my $row_as_html = $self->p->render('order/tabs/_second_row', ITEM => $item, TYPE => $self->type);
1034 ->html('#second_row_' . $item_id, $row_as_html)
1035 ->data('#second_row_' . $item_id, 'loaded', 1);
1038 sub js_redisplay_line_values {
1041 my $is_sales = $self->order->is_sales;
1043 # sales orders with margins
1048 $::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0),
1049 $::form->format_amount(\%::myconfig, $_->{marge_total}, 2, 0),
1050 $::form->format_amount(\%::myconfig, $_->{marge_percent}, 2, 0),
1051 ]} @{ $self->order->items_sorted };
1055 $::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0),
1056 ]} @{ $self->order->items_sorted };
1060 ->run('kivi.Order.redisplay_line_values', $is_sales, \@data);
1063 sub js_redisplay_amounts_and_taxes {
1066 if (scalar @{ $self->{taxes} }) {
1067 $self->js->show('#taxincluded_row_id');
1069 $self->js->hide('#taxincluded_row_id');
1072 if ($self->order->taxincluded) {
1073 $self->js->hide('#subtotal_row_id');
1075 $self->js->show('#subtotal_row_id');
1078 if ($self->order->is_sales) {
1079 my $is_neg = $self->order->marge_total < 0;
1081 ->html('#marge_total_id', $::form->format_amount(\%::myconfig, $self->order->marge_total, 2))
1082 ->html('#marge_percent_id', $::form->format_amount(\%::myconfig, $self->order->marge_percent, 2))
1083 ->action_if( $is_neg, 'addClass', '#marge_total_id', 'plus0')
1084 ->action_if( $is_neg, 'addClass', '#marge_percent_id', 'plus0')
1085 ->action_if( $is_neg, 'addClass', '#marge_percent_sign_id', 'plus0')
1086 ->action_if(!$is_neg, 'removeClass', '#marge_total_id', 'plus0')
1087 ->action_if(!$is_neg, 'removeClass', '#marge_percent_id', 'plus0')
1088 ->action_if(!$is_neg, 'removeClass', '#marge_percent_sign_id', 'plus0');
1092 ->html('#netamount_id', $::form->format_amount(\%::myconfig, $self->order->netamount, -2))
1093 ->html('#amount_id', $::form->format_amount(\%::myconfig, $self->order->amount, -2))
1094 ->remove('.tax_row')
1095 ->insertBefore($self->build_tax_rows, '#amount_row_id');
1098 sub js_redisplay_cvpartnumbers {
1101 $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
1103 my @data = map {[$_->{cvpartnumber}]} @{ $self->order->items_sorted };
1106 ->run('kivi.Order.redisplay_cvpartnumbers', \@data);
1109 sub js_reset_order_and_item_ids_after_save {
1113 ->val('#id', $self->order->id)
1114 ->val('#converted_from_oe_id', '')
1115 ->val('#order_' . $self->nr_key(), $self->order->number);
1118 foreach my $form_item_id (@{ $::form->{orderitem_ids} }) {
1119 next if !$self->order->items_sorted->[$idx]->id;
1120 next if $form_item_id !~ m{^new};
1122 ->val ('[name="orderitem_ids[+]"][value="' . $form_item_id . '"]', $self->order->items_sorted->[$idx]->id)
1123 ->val ('#item_' . $form_item_id, $self->order->items_sorted->[$idx]->id)
1124 ->attr('#item_' . $form_item_id, "id", 'item_' . $self->order->items_sorted->[$idx]->id);
1128 $self->js->val('[name="converted_from_orderitems_ids[+]"]', '');
1135 sub init_valid_types {
1136 [ sales_order_type(), purchase_order_type(), sales_quotation_type(), request_quotation_type() ];
1142 if (none { $::form->{type} eq $_ } @{$self->valid_types}) {
1143 die "Not a valid type for order";
1146 $self->type($::form->{type});
1152 my $cv = (any { $self->type eq $_ } (sales_order_type(), sales_quotation_type())) ? 'customer'
1153 : (any { $self->type eq $_ } (purchase_order_type(), request_quotation_type())) ? 'vendor'
1154 : die "Not a valid type for order";
1159 sub init_search_cvpartnumber {
1162 my $user_prefs = SL::Helper::UserPreferences::PartPickerSearch->new();
1163 my $search_cvpartnumber;
1164 $search_cvpartnumber = !!$user_prefs->get_sales_search_customer_partnumber() if $self->cv eq 'customer';
1165 $search_cvpartnumber = !!$user_prefs->get_purchase_search_makemodel() if $self->cv eq 'vendor';
1167 return $search_cvpartnumber;
1178 # model used to filter/display the parts in the multi-items dialog
1179 sub init_multi_items_models {
1180 SL::Controller::Helper::GetModels->new(
1181 controller => $_[0],
1183 with_objects => [ qw(unit_obj) ],
1184 disable_plugin => 'paginated',
1185 source => $::form->{multi_items},
1191 partnumber => t8('Partnumber'),
1192 description => t8('Description')}
1196 sub init_all_price_factors {
1197 SL::DB::Manager::PriceFactor->get_all;
1203 my $right_for = { map { $_ => $_.'_edit' } @{$self->valid_types} };
1205 my $right = $right_for->{ $self->type };
1206 $right ||= 'DOES_NOT_EXIST';
1208 $::auth->assert($right);
1211 # build the selection box for contacts
1213 # Needed, if customer/vendor changed.
1214 sub build_contact_select {
1217 select_tag('order.cp_id', [ $self->order->{$self->cv}->contacts ],
1218 value_key => 'cp_id',
1219 title_key => 'full_name_dep',
1220 default => $self->order->cp_id,
1222 style => 'width: 300px',
1226 # build the selection box for shiptos
1228 # Needed, if customer/vendor changed.
1229 sub build_shipto_select {
1232 select_tag('order.shipto_id', [ $self->order->{$self->cv}->shipto ],
1233 value_key => 'shipto_id',
1234 title_key => 'displayable_id',
1235 default => $self->order->shipto_id,
1237 style => 'width: 300px',
1241 # render the info line for business
1243 # Needed, if customer/vendor changed.
1244 sub build_business_info_row
1246 $_[0]->p->render('order/tabs/_business_info_row', SELF => $_[0]);
1249 # build the rows for displaying taxes
1251 # Called if amounts where recalculated and redisplayed.
1252 sub build_tax_rows {
1256 foreach my $tax (sort { $a->{tax}->rate cmp $b->{tax}->rate } @{ $self->{taxes} }) {
1257 $rows_as_html .= $self->p->render('order/tabs/_tax_row', TAX => $tax, TAXINCLUDED => $self->order->taxincluded);
1259 return $rows_as_html;
1263 sub render_price_dialog {
1264 my ($self, $record_item) = @_;
1266 my $price_source = SL::PriceSource->new(record_item => $record_item, record => $self->order);
1270 'kivi.io.price_chooser_dialog',
1271 t8('Available Prices'),
1272 $self->render('order/tabs/_price_sources_dialog', { output => 0 }, price_source => $price_source)
1277 # $self->js->text('#dialog_flash_error_content', join ' ', @errors);
1278 # $self->js->show('#dialog_flash_error');
1287 return if !$::form->{id};
1289 $self->order(SL::DB::Order->new(id => $::form->{id})->load);
1292 # load or create a new order object
1294 # And assign changes from the form to this object.
1295 # If the order is loaded from db, check if items are deleted in the form,
1296 # remove them form the object and collect them for removing from db on saving.
1297 # Then create/update items from form (via make_item) and add them.
1301 # add_items adds items to an order with no items for saving, but they cannot
1302 # be retrieved via items until the order is saved. Adding empty items to new
1303 # order here solves this problem.
1305 $order = SL::DB::Order->new(id => $::form->{id})->load(with => [ 'orderitems', 'orderitems.part' ]) if $::form->{id};
1306 $order ||= SL::DB::Order->new(orderitems => [],
1307 quotation => (any { $self->type eq $_ } (sales_quotation_type(), request_quotation_type())));
1309 my $cv_id_method = $self->cv . '_id';
1310 if (!$::form->{id} && $::form->{$cv_id_method}) {
1311 $order->$cv_id_method($::form->{$cv_id_method});
1312 setup_order_from_cv($order);
1315 my $form_orderitems = delete $::form->{order}->{orderitems};
1316 my $form_periodic_invoices_config = delete $::form->{order}->{periodic_invoices_config};
1318 $order->assign_attributes(%{$::form->{order}});
1320 if (my $periodic_invoices_config_attrs = $form_periodic_invoices_config ? SL::YAML::Load($form_periodic_invoices_config) : undef) {
1321 my $periodic_invoices_config = $order->periodic_invoices_config || $order->periodic_invoices_config(SL::DB::PeriodicInvoicesConfig->new);
1322 $periodic_invoices_config->assign_attributes(%$periodic_invoices_config_attrs);
1325 # remove deleted items
1326 $self->item_ids_to_delete([]);
1327 foreach my $idx (reverse 0..$#{$order->orderitems}) {
1328 my $item = $order->orderitems->[$idx];
1329 if (none { $item->id == $_->{id} } @{$form_orderitems}) {
1330 splice @{$order->orderitems}, $idx, 1;
1331 push @{$self->item_ids_to_delete}, $item->id;
1337 foreach my $form_attr (@{$form_orderitems}) {
1338 my $item = make_item($order, $form_attr);
1339 $item->position($pos);
1343 $order->add_items(grep {!$_->id} @items);
1348 # create or update items from form
1350 # Make item objects from form values. For items already existing read from db.
1351 # Create a new item else. And assign attributes.
1353 my ($record, $attr) = @_;
1356 $item = first { $_->id == $attr->{id} } @{$record->items} if $attr->{id};
1358 my $is_new = !$item;
1360 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
1361 # they cannot be retrieved via custom_variables until the order/orderitem is
1362 # saved. Adding empty custom_variables to new orderitem here solves this problem.
1363 $item ||= SL::DB::OrderItem->new(custom_variables => []);
1365 $item->assign_attributes(%$attr);
1366 $item->longdescription($item->part->notes) if $is_new && !defined $attr->{longdescription};
1367 $item->project_id($record->globalproject_id) if $is_new && !defined $attr->{project_id};
1368 $item->lastcost($record->is_sales ? $item->part->lastcost : 0) if $is_new && !defined $attr->{lastcost_as_number};
1375 # This is used to add one item
1377 my ($record, $attr) = @_;
1379 my $item = SL::DB::OrderItem->new;
1381 # Remove attributes where the user left or set the inputs empty.
1382 # So these attributes will be undefined and we can distinguish them
1383 # from zero later on.
1384 for (qw(qty_as_number sellprice_as_number discount_as_percent)) {
1385 delete $attr->{$_} if $attr->{$_} eq '';
1388 $item->assign_attributes(%$attr);
1390 my $part = SL::DB::Part->new(id => $attr->{parts_id})->load;
1391 my $price_source = SL::PriceSource->new(record_item => $item, record => $record);
1393 $item->unit($part->unit) if !$item->unit;
1396 if ( $part->is_assortment ) {
1397 # add assortment items with price 0, as the components carry the price
1398 $price_src = $price_source->price_from_source("");
1399 $price_src->price(0);
1400 } elsif (defined $item->sellprice) {
1401 $price_src = $price_source->price_from_source("");
1402 $price_src->price($item->sellprice);
1404 $price_src = $price_source->best_price
1405 ? $price_source->best_price
1406 : $price_source->price_from_source("");
1407 $price_src->price(0) if !$price_source->best_price;
1411 if (defined $item->discount) {
1412 $discount_src = $price_source->discount_from_source("");
1413 $discount_src->discount($item->discount);
1415 $discount_src = $price_source->best_discount
1416 ? $price_source->best_discount
1417 : $price_source->discount_from_source("");
1418 $discount_src->discount(0) if !$price_source->best_discount;
1422 $new_attr{part} = $part;
1423 $new_attr{description} = $part->description if ! $item->description;
1424 $new_attr{qty} = 1.0 if ! $item->qty;
1425 $new_attr{price_factor_id} = $part->price_factor_id if ! $item->price_factor_id;
1426 $new_attr{sellprice} = $price_src->price;
1427 $new_attr{discount} = $discount_src->discount;
1428 $new_attr{active_price_source} = $price_src;
1429 $new_attr{active_discount_source} = $discount_src;
1430 $new_attr{longdescription} = $part->notes if ! defined $attr->{longdescription};
1431 $new_attr{project_id} = $record->globalproject_id;
1432 $new_attr{lastcost} = $record->is_sales ? $part->lastcost : 0;
1434 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
1435 # they cannot be retrieved via custom_variables until the order/orderitem is
1436 # saved. Adding empty custom_variables to new orderitem here solves this problem.
1437 $new_attr{custom_variables} = [];
1439 $item->assign_attributes(%new_attr);
1444 sub setup_order_from_cv {
1447 $order->$_($order->customervendor->$_) for (qw(taxzone_id payment_id delivery_term_id));
1449 $order->intnotes($order->customervendor->notes);
1451 if ($order->is_sales) {
1452 $order->salesman_id($order->customer->salesman_id || SL::DB::Manager::Employee->current->id);
1453 $order->taxincluded(defined($order->customer->taxincluded_checked)
1454 ? $order->customer->taxincluded_checked
1455 : $::myconfig{taxincluded_checked});
1460 # recalculate prices and taxes
1462 # Using the PriceTaxCalculator. Store linetotals in the item objects.
1466 # bb: todo: currency later
1467 $self->order->currency_id($::instance_conf->get_currency_id());
1469 my %pat = $self->order->calculate_prices_and_taxes();
1470 $self->{taxes} = [];
1471 foreach my $tax_chart_id (keys %{ $pat{taxes} }) {
1472 my $tax = SL::DB::Manager::Tax->find_by(chart_id => $tax_chart_id);
1474 my @amount_keys = grep { $pat{amounts}->{$_}->{tax_id} == $tax->id } keys %{ $pat{amounts} };
1475 push(@{ $self->{taxes} }, { amount => $pat{taxes}->{$tax_chart_id},
1476 netamount => $pat{amounts}->{$amount_keys[0]}->{amount},
1480 pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items_sorted}, @{$pat{items}};
1483 # get data for saving, printing, ..., that is not changed in the form
1485 # Only cvars for now.
1486 sub get_unalterable_data {
1489 foreach my $item (@{ $self->order->items }) {
1490 # autovivify all cvars that are not in the form (cvars_by_config can do it).
1491 # workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
1492 foreach my $var (@{ $item->cvars_by_config }) {
1493 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
1495 $item->parse_custom_variable_values;
1501 # And remove related files in the spool directory
1506 my $db = $self->order->db;
1508 $db->with_transaction(
1510 my @spoolfiles = grep { $_ } map { $_->spoolfile } @{ SL::DB::Manager::Status->get_all(where => [ trans_id => $self->order->id ]) };
1511 $self->order->delete;
1512 my $spool = $::lx_office_conf{paths}->{spool};
1513 unlink map { "$spool/$_" } @spoolfiles if $spool;
1516 }) || push(@{$errors}, $db->error);
1523 # And delete items that are deleted in the form.
1528 my $db = $self->order->db;
1530 $db->with_transaction(sub {
1531 SL::DB::OrderItem->new(id => $_)->delete for @{$self->item_ids_to_delete || []};
1532 $self->order->save(cascade => 1);
1535 if ($::form->{converted_from_oe_id}) {
1536 my @converted_from_oe_ids = split ' ', $::form->{converted_from_oe_id};
1537 foreach my $converted_from_oe_id (@converted_from_oe_ids) {
1538 my $src = SL::DB::Order->new(id => $converted_from_oe_id)->load;
1539 $src->update_attributes(closed => 1) if $src->type =~ /_quotation$/;
1540 $src->link_to_record($self->order);
1542 if (scalar @{ $::form->{converted_from_orderitems_ids} || [] }) {
1544 foreach (@{ $self->order->items_sorted }) {
1545 my $from_id = $::form->{converted_from_orderitems_ids}->[$idx];
1547 SL::DB::RecordLink->new(from_table => 'orderitems',
1548 from_id => $from_id,
1549 to_table => 'orderitems',
1557 }) || push(@{$errors}, $db->error);
1562 sub workflow_sales_or_purchase_order {
1566 my $errors = $self->save();
1568 if (scalar @{ $errors }) {
1569 $self->js->flash('error', $_) foreach @{ $errors };
1570 return $self->js->render();
1573 my $destination_type = $::form->{type} eq sales_quotation_type() ? sales_order_type()
1574 : $::form->{type} eq request_quotation_type() ? purchase_order_type()
1575 : $::form->{type} eq purchase_order_type() ? sales_order_type()
1576 : $::form->{type} eq sales_order_type() ? purchase_order_type()
1579 $self->order(SL::DB::Order->new_from($self->order, destination_type => $destination_type));
1580 $self->{converted_from_oe_id} = delete $::form->{id};
1582 # set item ids to new fake id, to identify them as new items
1583 foreach my $item (@{$self->order->items_sorted}) {
1584 $item->{new_fake_id} = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
1588 $::form->{type} = $destination_type;
1589 $self->type($self->init_type);
1590 $self->cv ($self->init_cv);
1594 $self->get_unalterable_data();
1595 $self->pre_render();
1597 # trigger rendering values for second row/longdescription as hidden,
1598 # because they are loaded only on demand. So we need to keep the values
1600 $_->{render_second_row} = 1 for @{ $self->order->items_sorted };
1601 $_->{render_longdescription} = 1 for @{ $self->order->items_sorted };
1605 title => $self->get_title_for('edit'),
1606 %{$self->{template_args}}
1614 $self->{all_taxzones} = SL::DB::Manager::TaxZone->get_all_sorted();
1615 $self->{all_departments} = SL::DB::Manager::Department->get_all_sorted();
1616 $self->{all_employees} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->employee_id,
1619 $self->{all_salesmen} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->salesman_id,
1622 $self->{all_payment_terms} = SL::DB::Manager::PaymentTerm->get_all_sorted(where => [ or => [ id => $self->order->payment_id,
1624 $self->{all_delivery_terms} = SL::DB::Manager::DeliveryTerm->get_all_sorted();
1625 $self->{current_employee_id} = SL::DB::Manager::Employee->current->id;
1626 $self->{periodic_invoices_status} = $self->get_periodic_invoices_status($self->order->periodic_invoices_config);
1627 $self->{order_probabilities} = [ map { { title => ($_ * 10) . '%', id => $_ * 10 } } (0..10) ];
1628 $self->{positions_scrollbar_height} = SL::Helper::UserPreferences::PositionsScrollbar->new()->get_height();
1630 my $print_form = Form->new('');
1631 $print_form->{type} = $self->type;
1632 $print_form->{printers} = SL::DB::Manager::Printer->get_all_sorted;
1633 $print_form->{languages} = SL::DB::Manager::Language->get_all_sorted;
1634 $self->{print_options} = SL::Helper::PrintOptions->get_print_options(
1635 form => $print_form,
1636 options => {dialog_name_prefix => 'print_options.',
1640 no_opendocument => 0,
1644 foreach my $item (@{$self->order->orderitems}) {
1645 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
1646 $item->active_price_source( $price_source->price_from_source( $item->active_price_source ));
1647 $item->active_discount_source($price_source->discount_from_source($item->active_discount_source));
1650 if (any { $self->type eq $_ } (sales_order_type(), purchase_order_type())) {
1651 # calculate shipped qtys here to prevent calling calculate for every item via the items method
1652 SL::Helper::ShippedQty->new->calculate($self->order)->write_to_objects;
1655 if ($self->order->number && $::instance_conf->get_webdav) {
1656 my $webdav = SL::Webdav->new(
1657 type => $self->type,
1658 number => $self->order->number,
1660 my @all_objects = $webdav->get_all_objects;
1661 @{ $self->{template_args}->{WEBDAV} } = map { { name => $_->filename,
1663 link => File::Spec->catfile($_->full_filedescriptor),
1667 $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
1669 $::request->{layout}->use_javascript("${_}.js") for qw(kivi.SalesPurchase kivi.Order kivi.File ckeditor/ckeditor ckeditor/adapters/jquery edit_periodic_invoices_config calculate_qty);
1670 $self->setup_edit_action_bar;
1673 sub setup_edit_action_bar {
1674 my ($self, %params) = @_;
1676 my $deletion_allowed = (any { $self->type eq $_ } (sales_quotation_type(), request_quotation_type()))
1677 || (($self->type eq sales_order_type()) && $::instance_conf->get_sales_order_show_delete)
1678 || (($self->type eq purchase_order_type()) && $::instance_conf->get_purchase_order_show_delete);
1680 for my $bar ($::request->layout->get('actionbar')) {
1685 call => [ 'kivi.Order.save', 'save', $::instance_conf->get_order_warn_duplicate_parts,
1686 $::instance_conf->get_order_warn_no_deliverydate,
1688 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1692 call => [ 'kivi.Order.save', 'save_as_new', $::instance_conf->get_order_warn_duplicate_parts ],
1693 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1694 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1696 ], # end of combobox "Save"
1703 t8('Save and Sales Order'),
1704 submit => [ '#order_form', { action => "Order/sales_order" } ],
1705 only_if => (any { $self->type eq $_ } (sales_quotation_type(), purchase_order_type())),
1706 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1709 t8('Save and Purchase Order'),
1710 submit => [ '#order_form', { action => "Order/purchase_order" } ],
1711 only_if => (any { $self->type eq $_ } (sales_order_type(), request_quotation_type())),
1712 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1715 t8('Save and Delivery Order'),
1716 call => [ 'kivi.Order.save', 'save_and_delivery_order', $::instance_conf->get_order_warn_duplicate_parts,
1717 $::instance_conf->get_order_warn_no_deliverydate,
1719 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1720 only_if => (any { $self->type eq $_ } (sales_order_type(), purchase_order_type()))
1723 t8('Save and Invoice'),
1724 call => [ 'kivi.Order.save', 'save_and_invoice', $::instance_conf->get_order_warn_duplicate_parts ],
1725 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1728 t8('Save and AP Transaction'),
1729 call => [ 'kivi.Order.save', 'save_and_ap_transaction', $::instance_conf->get_order_warn_duplicate_parts ],
1730 only_if => (any { $self->type eq $_ } (purchase_order_type()))
1733 ], # end of combobox "Workflow"
1740 t8('Save and print'),
1741 call => [ 'kivi.Order.show_print_options', $::instance_conf->get_order_warn_duplicate_parts ],
1744 t8('Save and E-mail'),
1745 call => [ 'kivi.Order.email', $::instance_conf->get_order_warn_duplicate_parts ],
1748 t8('Download attachments of all parts'),
1749 call => [ 'kivi.File.downloadOrderitemsFiles', $::form->{type}, $::form->{id} ],
1750 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1751 only_if => $::instance_conf->get_doc_storage,
1753 ], # end of combobox "Export"
1757 call => [ 'kivi.Order.delete_order' ],
1758 confirm => $::locale->text('Do you really want to delete this object?'),
1759 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1760 only_if => $deletion_allowed,
1767 my ($order, $pdf_ref, $params) = @_;
1771 my $print_form = Form->new('');
1772 $print_form->{type} = $order->type;
1773 $print_form->{formname} = $params->{formname} || $order->type;
1774 $print_form->{format} = $params->{format} || 'pdf';
1775 $print_form->{media} = $params->{media} || 'file';
1776 $print_form->{groupitems} = $params->{groupitems};
1777 $print_form->{media} = 'file' if $print_form->{media} eq 'screen';
1779 $order->language($params->{language});
1780 $order->flatten_to_form($print_form, format_amounts => 1);
1784 if ($print_form->{format} =~ /(opendocument|oasis)/i) {
1785 $template_ext = 'odt';
1786 $template_type = 'OpenDocument';
1789 # search for the template
1790 my ($template_file, @template_files) = SL::Helper::CreatePDF->find_template(
1791 name => $print_form->{formname},
1792 extension => $template_ext,
1793 email => $print_form->{media} eq 'email',
1794 language => $params->{language},
1795 printer_id => $print_form->{printer_id}, # todo
1798 if (!defined $template_file) {
1799 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);
1802 return @errors if scalar @errors;
1804 $print_form->throw_on_error(sub {
1806 $print_form->prepare_for_printing;
1808 $$pdf_ref = SL::Helper::CreatePDF->create_pdf(
1809 format => $print_form->{format},
1810 template_type => $template_type,
1811 template => $template_file,
1812 variables => $print_form,
1813 variable_content_types => {
1814 longdescription => 'html',
1815 partnotes => 'html',
1820 } || push @errors, ref($EVAL_ERROR) eq 'SL::X::FormError' ? $EVAL_ERROR->error : $EVAL_ERROR;
1826 sub get_files_for_email_dialog {
1829 my %files = map { ($_ => []) } qw(versions files vc_files part_files);
1831 return %files if !$::instance_conf->get_doc_storage;
1833 if ($self->order->id) {
1834 $files{versions} = [ SL::File->get_all_versions(object_id => $self->order->id, object_type => $self->order->type, file_type => 'document') ];
1835 $files{files} = [ SL::File->get_all( object_id => $self->order->id, object_type => $self->order->type, file_type => 'attachment') ];
1836 $files{vc_files} = [ SL::File->get_all( object_id => $self->order->{$self->cv}->id, object_type => $self->cv, file_type => 'attachment') ];
1840 uniq_by { $_->{id} }
1842 +{ id => $_->part->id,
1843 partnumber => $_->part->partnumber }
1844 } @{$self->order->items_sorted};
1846 foreach my $part (@parts) {
1847 my @pfiles = SL::File->get_all(object_id => $part->{id}, object_type => 'part');
1848 push @{ $files{part_files} }, map { +{ %{ $_ }, partnumber => $part->{partnumber} } } @pfiles;
1851 foreach my $key (keys %files) {
1852 $files{$key} = [ sort_by { lc $_->{db_file}->{file_name} } @{ $files{$key} } ];
1858 sub make_periodic_invoices_config_from_yaml {
1859 my ($yaml_config) = @_;
1861 return if !$yaml_config;
1862 my $attr = SL::YAML::Load($yaml_config);
1863 return if 'HASH' ne ref $attr;
1864 return SL::DB::PeriodicInvoicesConfig->new(%$attr);
1868 sub get_periodic_invoices_status {
1869 my ($self, $config) = @_;
1871 return if $self->type ne sales_order_type();
1872 return t8('not configured') if !$config;
1874 my $active = ('HASH' eq ref $config) ? $config->{active}
1875 : ('SL::DB::PeriodicInvoicesConfig' eq ref $config) ? $config->active
1876 : die "Cannot get status of periodic invoices config";
1878 return $active ? t8('active') : t8('inactive');
1882 my ($self, $action) = @_;
1884 return '' if none { lc($action)} qw(add edit);
1887 # $::locale->text("Add Sales Order");
1888 # $::locale->text("Add Purchase Order");
1889 # $::locale->text("Add Quotation");
1890 # $::locale->text("Add Request for Quotation");
1891 # $::locale->text("Edit Sales Order");
1892 # $::locale->text("Edit Purchase Order");
1893 # $::locale->text("Edit Quotation");
1894 # $::locale->text("Edit Request for Quotation");
1896 $action = ucfirst(lc($action));
1897 return $self->type eq sales_order_type() ? $::locale->text("$action Sales Order")
1898 : $self->type eq purchase_order_type() ? $::locale->text("$action Purchase Order")
1899 : $self->type eq sales_quotation_type() ? $::locale->text("$action Quotation")
1900 : $self->type eq request_quotation_type() ? $::locale->text("$action Request for Quotation")
1904 sub get_item_cvpartnumber {
1905 my ($self, $item) = @_;
1907 if ($self->cv eq 'vendor') {
1908 my @mms = grep { $_->make eq $self->order->customervendor->id } @{$item->part->makemodels};
1909 $item->{cvpartnumber} = $mms[0]->model if scalar @mms;
1910 } elsif ($self->cv eq 'customer') {
1911 my @cps = grep { $_->customer_id eq $self->order->customervendor->id } @{$item->part->customerprices};
1912 $item->{cvpartnumber} = $cps[0]->customer_partnumber if scalar @cps;
1916 sub sales_order_type {
1920 sub purchase_order_type {
1924 sub sales_quotation_type {
1928 sub request_quotation_type {
1929 'request_quotation';
1933 return $_[0]->type eq sales_order_type() ? 'ordnumber'
1934 : $_[0]->type eq purchase_order_type() ? 'ordnumber'
1935 : $_[0]->type eq sales_quotation_type() ? 'quonumber'
1936 : $_[0]->type eq request_quotation_type() ? 'quonumber'
1948 SL::Controller::Order - controller for orders
1952 This is a new form to enter orders, completely rewritten with the use
1953 of controller and java script techniques.
1955 The aim is to provide the user a better experience and a faster workflow. Also
1956 the code should be more readable, more reliable and better to maintain.
1964 One input row, so that input happens every time at the same place.
1968 Use of pickers where possible.
1972 Possibility to enter more than one item at once.
1976 Item list in a scrollable area, so that the workflow buttons stay at
1981 Reordering item rows with drag and drop is possible. Sorting item rows is
1982 possible (by partnumber, description, qty, sellprice and discount for now).
1986 No C<update> is necessary. All entries and calculations are managed
1987 with ajax-calls and the page only reloads on C<save>.
1991 User can see changes immediately, because of the use of java script
2002 =item * C<SL/Controller/Order.pm>
2006 =item * C<template/webpages/order/form.html>
2010 =item * C<template/webpages/order/tabs/basic_data.html>
2012 Main tab for basic_data.
2014 This is the only tab here for now. "linked records" and "webdav" tabs are
2015 reused from generic code.
2019 =item * C<template/webpages/order/tabs/_business_info_row.html>
2021 For displaying information on business type
2023 =item * C<template/webpages/order/tabs/_item_input.html>
2025 The input line for items
2027 =item * C<template/webpages/order/tabs/_row.html>
2029 One row for already entered items
2031 =item * C<template/webpages/order/tabs/_tax_row.html>
2033 Displaying tax information
2035 =item * C<template/webpages/order/tabs/_multi_items_dialog.html>
2037 Dialog for entering more than one item at once
2039 =item * C<template/webpages/order/tabs/_multi_items_result.html>
2041 Results for the filter in the multi items dialog
2043 =item * C<template/webpages/order/tabs/_price_sources_dialog.html>
2045 Dialog for selecting price and discount sources
2049 =item * C<js/kivi.Order.js>
2051 java script functions
2063 =item * credit limit
2065 =item * more workflows (quotation, rfq)
2067 =item * price sources: little symbols showing better price / better discount
2069 =item * select units in input row?
2071 =item * custom shipto address
2073 =item * check for direct delivery (workflow sales order -> purchase order)
2075 =item * language / part translations
2077 =item * access rights
2079 =item * display weights
2085 =item * optional client/user behaviour
2087 (transactions has to be set - department has to be set -
2088 force project if enabled in client config - transport cost reminder)
2092 =head1 KNOWN BUGS AND CAVEATS
2098 Customer discount is not displayed as a valid discount in price source popup
2099 (this might be a bug in price sources)
2101 (I cannot reproduce this (Bernd))
2105 No indication that <shift>-up/down expands/collapses second row.
2109 Inline creation of parts is not currently supported
2113 Table header is not sticky in the scrolling area.
2117 Sorting does not include C<position>, neither does reordering.
2119 This behavior was implemented intentionally. But we can discuss, which behavior
2120 should be implemented.
2124 C<show_multi_items_dialog> does not use the currently inserted string for
2129 The language selected in print or email dialog is not saved when the order is saved.
2133 =head1 To discuss / Nice to have
2139 How to expand/collapse second row. Now it can be done clicking the icon or
2144 Possibility to change longdescription in input row?
2148 Possibility to select PriceSources in input row?
2152 This controller uses a (changed) copy of the template for the PriceSource
2153 dialog. Maybe there could be used one code source.
2157 Rounding-differences between this controller (PriceTaxCalculator) and the old
2158 form. This is not only a problem here, but also in all parts using the PTC.
2159 There exists a ticket and a patch. This patch should be testet.
2163 An indicator, if the actual inputs are saved (like in an
2164 editor or on text processing application).
2168 A warning when leaving the page without saveing unchanged inputs.
2175 Bernd Bleßmann E<lt>bernd@kivitendo-premium.deE<gt>