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;
13 use SL::Util qw(trim);
18 use SL::DB::PartsGroup;
21 use SL::DB::RecordLink;
23 use SL::Helper::CreatePDF qw(:all);
24 use SL::Helper::PrintOptions;
25 use SL::Helper::ShippedQty;
27 use SL::Controller::Helper::GetModels;
29 use List::Util qw(first);
30 use List::UtilsBy qw(sort_by uniq_by);
31 use List::MoreUtils qw(any none pairwise first_index);
32 use English qw(-no_match_vars);
37 use Rose::Object::MakeMethods::Generic
39 scalar => [ qw(item_ids_to_delete) ],
40 'scalar --get_set_init' => [ qw(order valid_types type cv p multi_items_models all_price_factors) ],
45 __PACKAGE__->run_before('check_auth');
47 __PACKAGE__->run_before('recalc',
48 only => [ qw(save save_as_new save_and_delivery_order save_and_invoice print send_email) ]);
50 __PACKAGE__->run_before('get_unalterable_data',
51 only => [ qw(save save_as_new save_and_delivery_order save_and_invoice print send_email) ]);
61 $self->order->transdate(DateTime->now_local());
62 my $extra_days = $self->{type} eq 'sales_quotation' ? $::instance_conf->get_reqdate_interval :
63 $self->{type} eq 'sales_order' ? $::instance_conf->get_delivery_date_interval : 1;
64 $self->order->reqdate(DateTime->today_local->next_workday(extra_days => $extra_days)) if !$self->order->reqdate;
70 title => $self->get_title_for('add'),
71 %{$self->{template_args}}
75 # edit an existing order
83 # this is to edit an order from an unsaved order object
85 # set item ids to new fake id, to identify them as new items
86 foreach my $item (@{$self->order->items_sorted}) {
87 $item->{new_fake_id} = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
89 # trigger rendering values for second row/longdescription as hidden,
90 # because they are loaded only on demand. So we need to keep the values
92 $_->{render_second_row} = 1 for @{ $self->order->items_sorted };
93 $_->{render_longdescription} = 1 for @{ $self->order->items_sorted };
100 title => $self->get_title_for('edit'),
101 %{$self->{template_args}}
105 # edit a collective order (consisting of one or more existing orders)
106 sub action_edit_collective {
110 my @multi_ids = map {
111 $_ =~ m{^multi_id_(\d+)$} && $::form->{'multi_id_' . $1} && $::form->{'trans_id_' . $1} && $::form->{'trans_id_' . $1}
112 } grep { $_ =~ m{^multi_id_\d+$} } keys %$::form;
114 # fall back to add if no ids are given
115 if (scalar @multi_ids == 0) {
120 # fall back to save as new if only one id is given
121 if (scalar @multi_ids == 1) {
122 $self->order(SL::DB::Order->new(id => $multi_ids[0])->load);
123 $self->action_save_as_new();
127 # make new order from given orders
128 my @multi_orders = map { SL::DB::Order->new(id => $_)->load } @multi_ids;
129 $self->{converted_from_oe_id} = join ' ', map { $_->id } @multi_orders;
130 $self->order(SL::DB::Order->new_from_multi(\@multi_orders, sort_sources_by => 'transdate'));
132 $self->action_edit();
139 my $errors = $self->delete();
141 if (scalar @{ $errors }) {
142 $self->js->flash('error', $_) foreach @{ $errors };
143 return $self->js->render();
146 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been deleted')
147 : $self->type eq purchase_order_type() ? $::locale->text('The order has been deleted')
148 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been deleted')
149 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been deleted')
151 flash_later('info', $text);
153 my @redirect_params = (
158 $self->redirect_to(@redirect_params);
165 my $errors = $self->save();
167 if (scalar @{ $errors }) {
168 $self->js->flash('error', $_) foreach @{ $errors };
169 return $self->js->render();
172 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
173 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
174 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
175 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
177 flash_later('info', $text);
179 my @redirect_params = (
182 id => $self->order->id,
185 $self->redirect_to(@redirect_params);
188 # save the order as new document an open it for edit
189 sub action_save_as_new {
192 my $order = $self->order;
195 $self->js->flash('error', t8('This object has not been saved yet.'));
196 return $self->js->render();
199 # load order from db to check if values changed
200 my $saved_order = SL::DB::Order->new(id => $order->id)->load;
203 # Lets assign a new number if the user hasn't changed the previous one.
204 # If it has been changed manually then use it as-is.
205 $new_attrs{number} = (trim($order->number) eq $saved_order->number)
207 : trim($order->number);
209 # Clear transdate unless changed
210 $new_attrs{transdate} = ($order->transdate == $saved_order->transdate)
211 ? DateTime->today_local
214 # Set new reqdate unless changed
215 if ($order->reqdate == $saved_order->reqdate) {
216 my $extra_days = $self->{type} eq 'sales_quotation' ? $::instance_conf->get_reqdate_interval :
217 $self->{type} eq 'sales_order' ? $::instance_conf->get_delivery_date_interval : 1;
218 $new_attrs{reqdate} = DateTime->today_local->next_workday(extra_days => $extra_days);
220 $new_attrs{reqdate} = $order->reqdate;
224 $new_attrs{employee} = SL::DB::Manager::Employee->current;
226 # Create new record from current one
227 $self->order(SL::DB::Order->new_from($order, destination_type => $order->type, attributes => \%new_attrs));
229 # no linked records on save as new
230 delete $::form->{$_} for qw(converted_from_oe_id converted_from_orderitems_ids);
233 $self->action_save();
238 # This is called if "print" is pressed in the print dialog.
239 # If PDF creation was requested and succeeded, the pdf is stored in a session
240 # file and the filename is stored as session value with an unique key. A
241 # javascript function with this key is then called. This function calls the
242 # download action below (action_download_pdf), which offers the file for
247 my $errors = $self->save();
249 if (scalar @{ $errors }) {
250 $self->js->flash('error', $_) foreach @{ $errors };
251 return $self->js->render();
254 $self->js->val('#id', $self->order->id)
255 ->val('#order_' . $self->nr_key(), $self->order->number);
257 my $format = $::form->{print_options}->{format};
258 my $media = $::form->{print_options}->{media};
259 my $formname = $::form->{print_options}->{formname};
260 my $copies = $::form->{print_options}->{copies};
261 my $groupitems = $::form->{print_options}->{groupitems};
263 # only pdf and opendocument by now
264 if (none { $format eq $_ } qw(pdf opendocument opendocument_pdf)) {
265 return $self->js->flash('error', t8('Format \'#1\' is not supported yet/anymore.', $format))->render;
268 # only screen or printer by now
269 if (none { $media eq $_ } qw(screen printer)) {
270 return $self->js->flash('error', t8('Media \'#1\' is not supported yet/anymore.', $media))->render;
274 $language = SL::DB::Language->new(id => $::form->{print_options}->{language_id})->load if $::form->{print_options}->{language_id};
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} = '_' . $language->template_code if $language;
283 my $pdf_filename = $form->generate_attachment_filename();
286 my @errors = generate_pdf($self->order, \$pdf, { format => $format,
287 formname => $formname,
288 language => $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 my $sfile = SL::SessionFile::Random->new(mode => "w");
297 $sfile->fh->print($pdf);
300 my $key = join('_', Time::HiRes::gettimeofday(), int rand 1000000000000);
301 $::auth->set_session_value("Order::print-${key}" => $sfile->file_name);
304 ->run('kivi.Order.download_pdf', $pdf_filename, $key)
305 ->flash('info', t8('The PDF has been created'));
307 } elsif ($media eq 'printer') {
309 my $printer_id = $::form->{print_options}->{printer_id};
310 SL::DB::Printer->new(id => $printer_id)->load->print_document(
315 $self->js->flash('info', t8('The PDF has been printed'));
318 # copy file to webdav folder
319 if ($self->order->number && $::instance_conf->get_webdav_documents) {
320 my $webdav = SL::Webdav->new(
322 number => $self->order->number,
324 my $webdav_file = SL::Webdav::File->new(
326 filename => $pdf_filename,
329 $webdav_file->store(data => \$pdf);
332 $self->js->flash('error', t8('Storing PDF to webdav folder failed: #1', $@));
335 if ($self->order->number && $::instance_conf->get_doc_storage) {
337 SL::File->save(object_id => $self->order->id,
338 object_type => $self->type,
339 mime_type => 'application/pdf',
341 file_type => 'document',
342 file_name => $pdf_filename,
343 file_contents => $pdf);
346 $self->js->flash('error', t8('Storing PDF in storage backend failed: #1', $@));
352 # offer pdf for download
354 # It needs to get the key for the session value to get the pdf file.
355 sub action_download_pdf {
358 my $key = $::form->{key};
359 my $tmp_filename = $::auth->get_session_value("Order::print-${key}");
360 return $self->send_file(
362 type => 'application/pdf',
363 name => $::form->{pdf_filename},
367 # open the email dialog
368 sub action_show_email_dialog {
371 my $cv_method = $self->cv;
373 if (!$self->order->$cv_method) {
374 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'))
379 $email_form->{to} = $self->order->contact->cp_email if $self->order->contact;
380 $email_form->{to} ||= $self->order->$cv_method->email;
381 $email_form->{cc} = $self->order->$cv_method->cc;
382 $email_form->{bcc} = join ', ', grep $_, $self->order->$cv_method->bcc, SL::DB::Default->get->global_bcc;
383 # Todo: get addresses from shipto, if any
385 my $form = Form->new;
386 $form->{$self->nr_key()} = $self->order->number;
387 $form->{formname} = $self->type;
388 $form->{type} = $self->type;
389 $form->{language} = 'de';
390 $form->{format} = 'pdf';
392 $email_form->{subject} = $form->generate_email_subject();
393 $email_form->{attachment_filename} = $form->generate_attachment_filename();
394 $email_form->{message} = $form->generate_email_body();
395 $email_form->{js_send_function} = 'kivi.Order.send_email()';
397 my %files = $self->get_files_for_email_dialog();
398 my $dialog_html = $self->render('common/_send_email_dialog', { output => 0 },
399 email_form => $email_form,
400 show_bcc => $::auth->assert('email_bcc', 'may fail'),
402 is_customer => $self->cv eq 'customer',
406 ->run('kivi.Order.show_email_dialog', $dialog_html)
413 # Todo: handling error messages: flash is not displayed in dialog, but in the main form
414 sub action_send_email {
417 my $errors = $self->save();
419 if (scalar @{ $errors }) {
420 $self->js->run('kivi.Order.close_email_dialog');
421 $self->js->flash('error', $_) foreach @{ $errors };
422 return $self->js->render();
425 $self->js->val('#id', $self->order->id)
426 ->val('#order_' . $self->nr_key(), $self->order->number);
428 my $email_form = delete $::form->{email_form};
429 my %field_names = (to => 'email');
431 $::form->{ $field_names{$_} // $_ } = $email_form->{$_} for keys %{ $email_form };
433 # for Form::cleanup which may be called in Form::send_email
434 $::form->{cwd} = getcwd();
435 $::form->{tmpdir} = $::lx_office_conf{paths}->{userspath};
437 $::form->{$_} = $::form->{print_options}->{$_} for keys %{ $::form->{print_options} };
438 $::form->{media} = 'email';
440 if (($::form->{attachment_policy} // '') !~ m{^(?:old_file|no_file)$}) {
442 $language = SL::DB::Language->new(id => $::form->{print_options}->{language_id})->load if $::form->{print_options}->{language_id};
445 my @errors = generate_pdf($self->order, \$pdf, {media => $::form->{media},
446 format => $::form->{print_options}->{format},
447 formname => $::form->{print_options}->{formname},
448 language => $language,
449 groupitems => $::form->{print_options}->{groupitems}});
450 if (scalar @errors) {
451 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
454 my $sfile = SL::SessionFile::Random->new(mode => "w");
455 $sfile->fh->print($pdf);
458 $::form->{tmpfile} = $sfile->file_name;
459 $::form->{tmpdir} = $sfile->get_path; # for Form::cleanup which may be called in Form::send_email
462 $::form->send_email(\%::myconfig, 'pdf');
465 my $intnotes = $self->order->intnotes;
466 $intnotes .= "\n\n" if $self->order->intnotes;
467 $intnotes .= t8('[email]') . "\n";
468 $intnotes .= t8('Date') . ": " . $::locale->format_date_object(DateTime->now_local, precision => 'seconds') . "\n";
469 $intnotes .= t8('To (email)') . ": " . $::form->{email} . "\n";
470 $intnotes .= t8('Cc') . ": " . $::form->{cc} . "\n" if $::form->{cc};
471 $intnotes .= t8('Bcc') . ": " . $::form->{bcc} . "\n" if $::form->{bcc};
472 $intnotes .= t8('Subject') . ": " . $::form->{subject} . "\n\n";
473 $intnotes .= t8('Message') . ": " . $::form->{message};
475 $self->order->update_attributes(intnotes => $intnotes);
478 ->val('#order_intnotes', $intnotes)
479 ->run('kivi.Order.close_email_dialog')
480 ->flash('info', t8('The email has been sent.'))
484 # open the periodic invoices config dialog
486 # If there are values in the form (i.e. dialog was opened before),
487 # then use this values. Create new ones, else.
488 sub action_show_periodic_invoices_config_dialog {
491 my $config = make_periodic_invoices_config_from_yaml(delete $::form->{config});
492 $config ||= SL::DB::Manager::PeriodicInvoicesConfig->find_by(oe_id => $::form->{id}) if $::form->{id};
493 $config ||= SL::DB::PeriodicInvoicesConfig->new(periodicity => 'm',
494 order_value_periodicity => 'p', # = same as periodicity
495 start_date_as_date => $::form->{transdate_as_date} || $::form->current_date,
496 extend_automatically_by => 12,
498 email_subject => GenericTranslations->get(
499 language_id => $::form->{language_id},
500 translation_type =>"preset_text_periodic_invoices_email_subject"),
501 email_body => GenericTranslations->get(
502 language_id => $::form->{language_id},
503 translation_type =>"preset_text_periodic_invoices_email_body"),
505 $config->periodicity('m') if none { $_ eq $config->periodicity } @SL::DB::PeriodicInvoicesConfig::PERIODICITIES;
506 $config->order_value_periodicity('p') if none { $_ eq $config->order_value_periodicity } ('p', @SL::DB::PeriodicInvoicesConfig::ORDER_VALUE_PERIODICITIES);
508 $::form->get_lists(printers => "ALL_PRINTERS",
509 charts => { key => 'ALL_CHARTS',
510 transdate => 'current_date' });
512 $::form->{AR} = [ grep { $_->{link} =~ m/(?:^|:)AR(?::|$)/ } @{ $::form->{ALL_CHARTS} } ];
514 if ($::form->{customer_id}) {
515 $::form->{ALL_CONTACTS} = SL::DB::Manager::Contact->get_all_sorted(where => [ cp_cv_id => $::form->{customer_id} ]);
516 $::form->{email_recipient_invoice_address} = SL::DB::Manager::Customer->find_by(id => $::form->{customer_id})->invoice_mail;
519 $self->render('oe/edit_periodic_invoices_config', { layout => 0 },
521 popup_js_close_function => 'kivi.Order.close_periodic_invoices_config_dialog()',
522 popup_js_assign_function => 'kivi.Order.assign_periodic_invoices_config()',
527 # assign the values of the periodic invoices config dialog
528 # as yaml in the hidden tag and set the status.
529 sub action_assign_periodic_invoices_config {
532 $::form->isblank('start_date_as_date', $::locale->text('The start date is missing.'));
534 my $config = { active => $::form->{active} ? 1 : 0,
535 terminated => $::form->{terminated} ? 1 : 0,
536 direct_debit => $::form->{direct_debit} ? 1 : 0,
537 periodicity => (any { $_ eq $::form->{periodicity} } @SL::DB::PeriodicInvoicesConfig::PERIODICITIES) ? $::form->{periodicity} : 'm',
538 order_value_periodicity => (any { $_ eq $::form->{order_value_periodicity} } ('p', @SL::DB::PeriodicInvoicesConfig::ORDER_VALUE_PERIODICITIES)) ? $::form->{order_value_periodicity} : 'p',
539 start_date_as_date => $::form->{start_date_as_date},
540 end_date_as_date => $::form->{end_date_as_date},
541 first_billing_date_as_date => $::form->{first_billing_date_as_date},
542 print => $::form->{print} ? 1 : 0,
543 printer_id => $::form->{print} ? $::form->{printer_id} * 1 : undef,
544 copies => $::form->{copies} * 1 ? $::form->{copies} : 1,
545 extend_automatically_by => $::form->{extend_automatically_by} * 1 || undef,
546 ar_chart_id => $::form->{ar_chart_id} * 1,
547 send_email => $::form->{send_email} ? 1 : 0,
548 email_recipient_contact_id => $::form->{email_recipient_contact_id} * 1 || undef,
549 email_recipient_address => $::form->{email_recipient_address},
550 email_sender => $::form->{email_sender},
551 email_subject => $::form->{email_subject},
552 email_body => $::form->{email_body},
555 my $periodic_invoices_config = YAML::Dump($config);
557 my $status = $self->get_periodic_invoices_status($config);
560 ->remove('#order_periodic_invoices_config')
561 ->insertAfter(hidden_tag('order.periodic_invoices_config', $periodic_invoices_config), '#periodic_invoices_status')
562 ->run('kivi.Order.close_periodic_invoices_config_dialog')
563 ->html('#periodic_invoices_status', $status)
564 ->flash('info', t8('The periodic invoices config has been assigned.'))
568 sub action_get_has_active_periodic_invoices {
571 my $config = make_periodic_invoices_config_from_yaml(delete $::form->{config});
572 $config ||= SL::DB::Manager::PeriodicInvoicesConfig->find_by(oe_id => $::form->{id}) if $::form->{id};
574 my $has_active_periodic_invoices =
575 $self->type eq sales_order_type()
578 && (!$config->end_date || ($config->end_date > DateTime->today_local))
579 && $config->get_previous_billed_period_start_date;
581 $_[0]->render(\ !!$has_active_periodic_invoices, { type => 'text' });
584 # save the order and redirect to the frontend subroutine for a new
586 sub action_save_and_delivery_order {
589 my $errors = $self->save();
591 if (scalar @{ $errors }) {
592 $self->js->flash('error', $_) foreach @{ $errors };
593 return $self->js->render();
596 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
597 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
598 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
599 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
601 flash_later('info', $text);
603 my @redirect_params = (
604 controller => 'oe.pl',
605 action => 'oe_delivery_order_from_order',
606 id => $self->order->id,
609 $self->redirect_to(@redirect_params);
612 # save the order and redirect to the frontend subroutine for a new
614 sub action_save_and_invoice {
617 my $errors = $self->save();
619 if (scalar @{ $errors }) {
620 $self->js->flash('error', $_) foreach @{ $errors };
621 return $self->js->render();
624 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
625 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
626 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
627 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
629 flash_later('info', $text);
631 my @redirect_params = (
632 controller => 'oe.pl',
633 action => 'oe_invoice_from_order',
634 id => $self->order->id,
637 $self->redirect_to(@redirect_params);
640 # workflow from sales quotation to sales order
641 sub action_sales_order {
642 $_[0]->workflow_sales_or_purchase_order();
645 # workflow from rfq to purchase order
646 sub action_purchase_order {
647 $_[0]->workflow_sales_or_purchase_order();
650 # set form elements in respect to a changed customer or vendor
652 # This action is called on an change of the customer/vendor picker.
653 sub action_customer_vendor_changed {
656 setup_order_from_cv($self->order);
659 my $cv_method = $self->cv;
661 if ($self->order->$cv_method->contacts && scalar @{ $self->order->$cv_method->contacts } > 0) {
662 $self->js->show('#cp_row');
664 $self->js->hide('#cp_row');
667 if ($self->order->$cv_method->shipto && scalar @{ $self->order->$cv_method->shipto } > 0) {
668 $self->js->show('#shipto_row');
670 $self->js->hide('#shipto_row');
673 $self->js->val( '#order_salesman_id', $self->order->salesman_id) if $self->order->is_sales;
676 ->replaceWith('#order_cp_id', $self->build_contact_select)
677 ->replaceWith('#order_shipto_id', $self->build_shipto_select)
678 ->replaceWith('#business_info_row', $self->build_business_info_row)
679 ->val( '#order_taxzone_id', $self->order->taxzone_id)
680 ->val( '#order_taxincluded', $self->order->taxincluded)
681 ->val( '#order_payment_id', $self->order->payment_id)
682 ->val( '#order_delivery_term_id', $self->order->delivery_term_id)
683 ->val( '#order_intnotes', $self->order->intnotes)
684 ->val( '#language_id', $self->order->$cv_method->language_id)
685 ->focus( '#order_' . $self->cv . '_id');
687 $self->js_redisplay_amounts_and_taxes;
691 # open the dialog for customer/vendor details
692 sub action_show_customer_vendor_details_dialog {
695 my $is_customer = 'customer' eq $::form->{vc};
698 $cv = SL::DB::Customer->new(id => $::form->{vc_id})->load;
700 $cv = SL::DB::Vendor->new(id => $::form->{vc_id})->load;
703 my %details = map { $_ => $cv->$_ } @{$cv->meta->columns};
704 $details{discount_as_percent} = $cv->discount_as_percent;
705 $details{creditlimt} = $cv->creditlimit_as_number;
706 $details{business} = $cv->business->description if $cv->business;
707 $details{language} = $cv->language_obj->description if $cv->language_obj;
708 $details{delivery_terms} = $cv->delivery_term->description if $cv->delivery_term;
709 $details{payment_terms} = $cv->payment->description if $cv->payment;
710 $details{pricegroup} = $cv->pricegroup->pricegroup if $is_customer && $cv->pricegroup;
712 foreach my $entry (@{ $cv->shipto }) {
713 push @{ $details{SHIPTO} }, { map { $_ => $entry->$_ } @{$entry->meta->columns} };
715 foreach my $entry (@{ $cv->contacts }) {
716 push @{ $details{CONTACTS} }, { map { $_ => $entry->$_ } @{$entry->meta->columns} };
719 $_[0]->render('common/show_vc_details', { layout => 0 },
720 is_customer => $is_customer,
725 # called if a unit in an existing item row is changed
726 sub action_unit_changed {
729 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
730 my $item = $self->order->items_sorted->[$idx];
732 my $old_unit_obj = SL::DB::Unit->new(name => $::form->{old_unit})->load;
733 $item->sellprice($item->unit_obj->convert_to($item->sellprice, $old_unit_obj));
738 ->run('kivi.Order.update_sellprice', $::form->{item_id}, $item->sellprice_as_number);
739 $self->js_redisplay_line_values;
740 $self->js_redisplay_amounts_and_taxes;
744 # add an item row for a new item entered in the input row
745 sub action_add_item {
748 my $form_attr = $::form->{add_item};
750 return unless $form_attr->{parts_id};
752 my $item = new_item($self->order, $form_attr);
754 $self->order->add_items($item);
758 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
759 my $row_as_html = $self->p->render('order/tabs/_row',
763 ALL_PRICE_FACTORS => $self->all_price_factors
767 ->append('#row_table_id', $row_as_html);
769 if ( $item->part->is_assortment ) {
770 $form_attr->{qty_as_number} = 1 unless $form_attr->{qty_as_number};
771 foreach my $assortment_item ( @{$item->part->assortment_items} ) {
772 my $attr = { parts_id => $assortment_item->parts_id,
773 qty => $assortment_item->qty * $::form->parse_amount(\%::myconfig, $form_attr->{qty_as_number}), # TODO $form_attr->{unit}
774 unit => $assortment_item->unit,
775 description => $assortment_item->part->description,
777 my $item = new_item($self->order, $attr);
779 # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount
780 $item->discount(1) unless $assortment_item->charge;
782 $self->order->add_items( $item );
784 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
785 my $row_as_html = $self->p->render('order/tabs/_row',
789 ALL_PRICE_FACTORS => $self->all_price_factors
792 ->append('#row_table_id', $row_as_html);
797 ->val('.add_item_input', '')
798 ->run('kivi.Order.init_row_handlers')
799 ->run('kivi.Order.row_table_scroll_down')
800 ->run('kivi.Order.renumber_positions')
801 ->focus('#add_item_parts_id_name');
803 $self->js_redisplay_amounts_and_taxes;
807 # open the dialog for entering multiple items at once
808 sub action_show_multi_items_dialog {
809 $_[0]->render('order/tabs/_multi_items_dialog', { layout => 0 },
810 all_partsgroups => SL::DB::Manager::PartsGroup->get_all);
813 # update the filter results in the multi item dialog
814 sub action_multi_items_update_result {
817 $::form->{multi_items}->{filter}->{obsolete} = 0;
819 my $count = $_[0]->multi_items_models->count;
822 my $text = SL::Presenter::EscapedText->new(text => $::locale->text('No results.'));
823 $_[0]->render($text, { layout => 0 });
824 } elsif ($count > $max_count) {
825 my $text = SL::Presenter::EscapedText->new(text => $::locale->text('Too many results (#1 from #2).', $count, $max_count));
826 $_[0]->render($text, { layout => 0 });
828 my $multi_items = $_[0]->multi_items_models->get;
829 $_[0]->render('order/tabs/_multi_items_result', { layout => 0 },
830 multi_items => $multi_items);
834 # add item rows for multiple items at once
835 sub action_add_multi_items {
838 my @form_attr = grep { $_->{qty_as_number} } @{ $::form->{add_multi_items} };
839 return $self->js->render() unless scalar @form_attr;
842 foreach my $attr (@form_attr) {
843 my $item = new_item($self->order, $attr);
845 if ( $item->part->is_assortment ) {
846 foreach my $assortment_item ( @{$item->part->assortment_items} ) {
847 my $attr = { parts_id => $assortment_item->parts_id,
848 qty => $assortment_item->qty * $item->qty, # TODO $form_attr->{unit}
849 unit => $assortment_item->unit,
850 description => $assortment_item->part->description,
852 my $item = new_item($self->order, $attr);
854 # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount
855 $item->discount(1) unless $assortment_item->charge;
860 $self->order->add_items(@items);
864 foreach my $item (@items) {
865 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
866 my $row_as_html = $self->p->render('order/tabs/_row',
870 ALL_PRICE_FACTORS => $self->all_price_factors
873 $self->js->append('#row_table_id', $row_as_html);
877 ->run('kivi.Order.close_multi_items_dialog')
878 ->run('kivi.Order.init_row_handlers')
879 ->run('kivi.Order.row_table_scroll_down')
880 ->run('kivi.Order.renumber_positions')
881 ->focus('#add_item_parts_id_name');
883 $self->js_redisplay_amounts_and_taxes;
887 # recalculate all linetotals, amounts and taxes and redisplay them
888 sub action_recalc_amounts_and_taxes {
893 $self->js_redisplay_line_values;
894 $self->js_redisplay_amounts_and_taxes;
898 # redisplay item rows if they are sorted by an attribute
899 sub action_reorder_items {
903 partnumber => sub { $_[0]->part->partnumber },
904 description => sub { $_[0]->description },
905 qty => sub { $_[0]->qty },
906 sellprice => sub { $_[0]->sellprice },
907 discount => sub { $_[0]->discount },
910 my $method = $sort_keys{$::form->{order_by}};
911 my @to_sort = map { { old_pos => $_->position, order_by => $method->($_) } } @{ $self->order->items_sorted };
912 if ($::form->{sort_dir}) {
913 @to_sort = sort { Sort::Naturally::ncmp($a->{order_by}, $b->{order_by} ) } @to_sort;
915 @to_sort = sort { Sort::Naturally::ncmp($b->{order_by}, $a->{order_by} ) } @to_sort;
918 ->run('kivi.Order.redisplay_items', \@to_sort)
922 # show the popup to choose a price/discount source
923 sub action_price_popup {
926 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
927 my $item = $self->order->items_sorted->[$idx];
929 $self->render_price_dialog($item);
932 # get the longdescription for an item if the dialog to enter/change the
933 # longdescription was opened and the longdescription is empty
935 # If this item is new, get the longdescription from Part.
936 # Otherwise get it from OrderItem.
937 sub action_get_item_longdescription {
940 if ($::form->{item_id}) {
941 $longdescription = SL::DB::OrderItem->new(id => $::form->{item_id})->load->longdescription;
942 } elsif ($::form->{parts_id}) {
943 $longdescription = SL::DB::Part->new(id => $::form->{parts_id})->load->notes;
945 $_[0]->render(\ $longdescription, { type => 'text' });
948 # load the second row for one or more items
950 # This action gets the html code for all items second rows by rendering a template for
951 # the second row and sets the html code via client js.
952 sub action_load_second_rows {
955 $self->recalc() if $self->order->is_sales; # for margin calculation
957 foreach my $item_id (@{ $::form->{item_ids} }) {
958 my $idx = first_index { $_ eq $item_id } @{ $::form->{orderitem_ids} };
959 my $item = $self->order->items_sorted->[$idx];
961 $self->js_load_second_row($item, $item_id, 0);
964 $self->js->run('kivi.Order.init_row_handlers') if $self->order->is_sales; # for lastcosts change-callback
969 sub js_load_second_row {
970 my ($self, $item, $item_id, $do_parse) = @_;
973 # Parse values from form (they are formated while rendering (template)).
974 # Workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
975 # This parsing is not necessary at all, if we assure that the second row/cvars are only loaded once.
976 foreach my $var (@{ $item->cvars_by_config }) {
977 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
979 $item->parse_custom_variable_values;
982 my $row_as_html = $self->p->render('order/tabs/_second_row', ITEM => $item, TYPE => $self->type);
985 ->html('#second_row_' . $item_id, $row_as_html)
986 ->data('#second_row_' . $item_id, 'loaded', 1);
989 sub js_redisplay_line_values {
992 my $is_sales = $self->order->is_sales;
994 # sales orders with margins
999 $::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0),
1000 $::form->format_amount(\%::myconfig, $_->{marge_total}, 2, 0),
1001 $::form->format_amount(\%::myconfig, $_->{marge_percent}, 2, 0),
1002 ]} @{ $self->order->items_sorted };
1006 $::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0),
1007 ]} @{ $self->order->items_sorted };
1011 ->run('kivi.Order.redisplay_line_values', $is_sales, \@data);
1014 sub js_redisplay_amounts_and_taxes {
1017 if (scalar @{ $self->{taxes} }) {
1018 $self->js->show('#taxincluded_row_id');
1020 $self->js->hide('#taxincluded_row_id');
1023 if ($self->order->taxincluded) {
1024 $self->js->hide('#subtotal_row_id');
1026 $self->js->show('#subtotal_row_id');
1029 if ($self->order->is_sales) {
1030 my $is_neg = $self->order->marge_total < 0;
1032 ->html('#marge_total_id', $::form->format_amount(\%::myconfig, $self->order->marge_total, 2))
1033 ->html('#marge_percent_id', $::form->format_amount(\%::myconfig, $self->order->marge_percent, 2))
1034 ->action_if( $is_neg, 'addClass', '#marge_total_id', 'plus0')
1035 ->action_if( $is_neg, 'addClass', '#marge_percent_id', 'plus0')
1036 ->action_if( $is_neg, 'addClass', '#marge_percent_sign_id', 'plus0')
1037 ->action_if(!$is_neg, 'removeClass', '#marge_total_id', 'plus0')
1038 ->action_if(!$is_neg, 'removeClass', '#marge_percent_id', 'plus0')
1039 ->action_if(!$is_neg, 'removeClass', '#marge_percent_sign_id', 'plus0');
1043 ->html('#netamount_id', $::form->format_amount(\%::myconfig, $self->order->netamount, -2))
1044 ->html('#amount_id', $::form->format_amount(\%::myconfig, $self->order->amount, -2))
1045 ->remove('.tax_row')
1046 ->insertBefore($self->build_tax_rows, '#amount_row_id');
1053 sub init_valid_types {
1054 [ sales_order_type(), purchase_order_type(), sales_quotation_type(), request_quotation_type() ];
1060 if (none { $::form->{type} eq $_ } @{$self->valid_types}) {
1061 die "Not a valid type for order";
1064 $self->type($::form->{type});
1070 my $cv = (any { $self->type eq $_ } (sales_order_type(), sales_quotation_type())) ? 'customer'
1071 : (any { $self->type eq $_ } (purchase_order_type(), request_quotation_type())) ? 'vendor'
1072 : die "Not a valid type for order";
1085 # model used to filter/display the parts in the multi-items dialog
1086 sub init_multi_items_models {
1087 SL::Controller::Helper::GetModels->new(
1088 controller => $_[0],
1090 with_objects => [ qw(unit_obj) ],
1091 disable_plugin => 'paginated',
1092 source => $::form->{multi_items},
1098 partnumber => t8('Partnumber'),
1099 description => t8('Description')}
1103 sub init_all_price_factors {
1104 SL::DB::Manager::PriceFactor->get_all;
1110 my $right_for = { map { $_ => $_.'_edit' } @{$self->valid_types} };
1112 my $right = $right_for->{ $self->type };
1113 $right ||= 'DOES_NOT_EXIST';
1115 $::auth->assert($right);
1118 # build the selection box for contacts
1120 # Needed, if customer/vendor changed.
1121 sub build_contact_select {
1124 select_tag('order.cp_id', [ $self->order->{$self->cv}->contacts ],
1125 value_key => 'cp_id',
1126 title_key => 'full_name_dep',
1127 default => $self->order->cp_id,
1129 style => 'width: 300px',
1133 # build the selection box for shiptos
1135 # Needed, if customer/vendor changed.
1136 sub build_shipto_select {
1139 select_tag('order.shipto_id', [ $self->order->{$self->cv}->shipto ],
1140 value_key => 'shipto_id',
1141 title_key => 'displayable_id',
1142 default => $self->order->shipto_id,
1144 style => 'width: 300px',
1148 # render the info line for business
1150 # Needed, if customer/vendor changed.
1151 sub build_business_info_row
1153 $_[0]->p->render('order/tabs/_business_info_row', SELF => $_[0]);
1156 # build the rows for displaying taxes
1158 # Called if amounts where recalculated and redisplayed.
1159 sub build_tax_rows {
1163 foreach my $tax (sort { $a->{tax}->rate cmp $b->{tax}->rate } @{ $self->{taxes} }) {
1164 $rows_as_html .= $self->p->render('order/tabs/_tax_row', TAX => $tax, TAXINCLUDED => $self->order->taxincluded);
1166 return $rows_as_html;
1170 sub render_price_dialog {
1171 my ($self, $record_item) = @_;
1173 my $price_source = SL::PriceSource->new(record_item => $record_item, record => $self->order);
1177 'kivi.io.price_chooser_dialog',
1178 t8('Available Prices'),
1179 $self->render('order/tabs/_price_sources_dialog', { output => 0 }, price_source => $price_source)
1184 # $self->js->text('#dialog_flash_error_content', join ' ', @errors);
1185 # $self->js->show('#dialog_flash_error');
1194 return if !$::form->{id};
1196 $self->order(SL::DB::Order->new(id => $::form->{id})->load);
1199 # load or create a new order object
1201 # And assign changes from the form to this object.
1202 # If the order is loaded from db, check if items are deleted in the form,
1203 # remove them form the object and collect them for removing from db on saving.
1204 # Then create/update items from form (via make_item) and add them.
1208 # add_items adds items to an order with no items for saving, but they cannot
1209 # be retrieved via items until the order is saved. Adding empty items to new
1210 # order here solves this problem.
1212 $order = SL::DB::Order->new(id => $::form->{id})->load(with => [ 'orderitems', 'orderitems.part' ]) if $::form->{id};
1213 $order ||= SL::DB::Order->new(orderitems => [],
1214 quotation => (any { $self->type eq $_ } (sales_quotation_type(), request_quotation_type())));
1216 my $cv_id_method = $self->cv . '_id';
1217 if (!$::form->{id} && $::form->{$cv_id_method}) {
1218 $order->$cv_id_method($::form->{$cv_id_method});
1219 setup_order_from_cv($order);
1222 my $form_orderitems = delete $::form->{order}->{orderitems};
1223 my $form_periodic_invoices_config = delete $::form->{order}->{periodic_invoices_config};
1225 $order->assign_attributes(%{$::form->{order}});
1227 if (my $periodic_invoices_config_attrs = $form_periodic_invoices_config ? YAML::Load($form_periodic_invoices_config) : undef) {
1228 my $periodic_invoices_config = $order->periodic_invoices_config || $order->periodic_invoices_config(SL::DB::PeriodicInvoicesConfig->new);
1229 $periodic_invoices_config->assign_attributes(%$periodic_invoices_config_attrs);
1232 # remove deleted items
1233 $self->item_ids_to_delete([]);
1234 foreach my $idx (reverse 0..$#{$order->orderitems}) {
1235 my $item = $order->orderitems->[$idx];
1236 if (none { $item->id == $_->{id} } @{$form_orderitems}) {
1237 splice @{$order->orderitems}, $idx, 1;
1238 push @{$self->item_ids_to_delete}, $item->id;
1244 foreach my $form_attr (@{$form_orderitems}) {
1245 my $item = make_item($order, $form_attr);
1246 $item->position($pos);
1250 $order->add_items(grep {!$_->id} @items);
1255 # create or update items from form
1257 # Make item objects from form values. For items already existing read from db.
1258 # Create a new item else. And assign attributes.
1260 my ($record, $attr) = @_;
1263 $item = first { $_->id == $attr->{id} } @{$record->items} if $attr->{id};
1265 my $is_new = !$item;
1267 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
1268 # they cannot be retrieved via custom_variables until the order/orderitem is
1269 # saved. Adding empty custom_variables to new orderitem here solves this problem.
1270 $item ||= SL::DB::OrderItem->new(custom_variables => []);
1272 $item->assign_attributes(%$attr);
1273 $item->longdescription($item->part->notes) if $is_new && !defined $attr->{longdescription};
1274 $item->project_id($record->globalproject_id) if $is_new && !defined $attr->{project_id};
1275 $item->lastcost($record->is_sales ? $item->part->lastcost : 0) if $is_new && !defined $attr->{lastcost_as_number};
1282 # This is used to add one item
1284 my ($record, $attr) = @_;
1286 my $item = SL::DB::OrderItem->new;
1288 # Remove attributes where the user left or set the inputs empty.
1289 # So these attributes will be undefined and we can distinguish them
1290 # from zero later on.
1291 for (qw(qty_as_number sellprice_as_number discount_as_percent)) {
1292 delete $attr->{$_} if $attr->{$_} eq '';
1295 $item->assign_attributes(%$attr);
1297 my $part = SL::DB::Part->new(id => $attr->{parts_id})->load;
1298 my $price_source = SL::PriceSource->new(record_item => $item, record => $record);
1300 $item->unit($part->unit) if !$item->unit;
1303 if ( $part->is_assortment ) {
1304 # add assortment items with price 0, as the components carry the price
1305 $price_src = $price_source->price_from_source("");
1306 $price_src->price(0);
1307 } elsif (defined $item->sellprice) {
1308 $price_src = $price_source->price_from_source("");
1309 $price_src->price($item->sellprice);
1311 $price_src = $price_source->best_price
1312 ? $price_source->best_price
1313 : $price_source->price_from_source("");
1314 $price_src->price(0) if !$price_source->best_price;
1318 if (defined $item->discount) {
1319 $discount_src = $price_source->discount_from_source("");
1320 $discount_src->discount($item->discount);
1322 $discount_src = $price_source->best_discount
1323 ? $price_source->best_discount
1324 : $price_source->discount_from_source("");
1325 $discount_src->discount(0) if !$price_source->best_discount;
1329 $new_attr{part} = $part;
1330 $new_attr{description} = $part->description if ! $item->description;
1331 $new_attr{qty} = 1.0 if ! $item->qty;
1332 $new_attr{price_factor_id} = $part->price_factor_id if ! $item->price_factor_id;
1333 $new_attr{sellprice} = $price_src->price;
1334 $new_attr{discount} = $discount_src->discount;
1335 $new_attr{active_price_source} = $price_src;
1336 $new_attr{active_discount_source} = $discount_src;
1337 $new_attr{longdescription} = $part->notes if ! defined $attr->{longdescription};
1338 $new_attr{project_id} = $record->globalproject_id;
1339 $new_attr{lastcost} = $record->is_sales ? $part->lastcost : 0;
1341 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
1342 # they cannot be retrieved via custom_variables until the order/orderitem is
1343 # saved. Adding empty custom_variables to new orderitem here solves this problem.
1344 $new_attr{custom_variables} = [];
1346 $item->assign_attributes(%new_attr);
1351 sub setup_order_from_cv {
1354 $order->$_($order->customervendor->$_) for (qw(taxzone_id payment_id delivery_term_id));
1356 $order->intnotes($order->customervendor->notes);
1358 if ($order->is_sales) {
1359 $order->salesman_id($order->customer->salesman_id || SL::DB::Manager::Employee->current->id);
1360 $order->taxincluded(defined($order->customer->taxincluded_checked)
1361 ? $order->customer->taxincluded_checked
1362 : $::myconfig{taxincluded_checked});
1367 # recalculate prices and taxes
1369 # Using the PriceTaxCalculator. Store linetotals in the item objects.
1373 # bb: todo: currency later
1374 $self->order->currency_id($::instance_conf->get_currency_id());
1376 my %pat = $self->order->calculate_prices_and_taxes();
1377 $self->{taxes} = [];
1378 foreach my $tax_chart_id (keys %{ $pat{taxes} }) {
1379 my $tax = SL::DB::Manager::Tax->find_by(chart_id => $tax_chart_id);
1381 my @amount_keys = grep { $pat{amounts}->{$_}->{tax_id} == $tax->id } keys %{ $pat{amounts} };
1382 push(@{ $self->{taxes} }, { amount => $pat{taxes}->{$tax_chart_id},
1383 netamount => $pat{amounts}->{$amount_keys[0]}->{amount},
1387 pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items_sorted}, @{$pat{items}};
1390 # get data for saving, printing, ..., that is not changed in the form
1392 # Only cvars for now.
1393 sub get_unalterable_data {
1396 foreach my $item (@{ $self->order->items }) {
1397 # autovivify all cvars that are not in the form (cvars_by_config can do it).
1398 # workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
1399 foreach my $var (@{ $item->cvars_by_config }) {
1400 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
1402 $item->parse_custom_variable_values;
1408 # And remove related files in the spool directory
1413 my $db = $self->order->db;
1415 $db->with_transaction(
1417 my @spoolfiles = grep { $_ } map { $_->spoolfile } @{ SL::DB::Manager::Status->get_all(where => [ trans_id => $self->order->id ]) };
1418 $self->order->delete;
1419 my $spool = $::lx_office_conf{paths}->{spool};
1420 unlink map { "$spool/$_" } @spoolfiles if $spool;
1423 }) || push(@{$errors}, $db->error);
1430 # And delete items that are deleted in the form.
1435 my $db = $self->order->db;
1437 $db->with_transaction(sub {
1438 SL::DB::OrderItem->new(id => $_)->delete for @{$self->item_ids_to_delete || []};
1439 $self->order->save(cascade => 1);
1442 if ($::form->{converted_from_oe_id}) {
1443 my @converted_from_oe_ids = split ' ', $::form->{converted_from_oe_id};
1444 foreach my $converted_from_oe_id (@converted_from_oe_ids) {
1445 my $src = SL::DB::Order->new(id => $converted_from_oe_id)->load;
1446 $src->update_attributes(closed => 1) if $src->type =~ /_quotation$/;
1447 $src->link_to_record($self->order);
1449 if (scalar @{ $::form->{converted_from_orderitems_ids} || [] }) {
1451 foreach (@{ $self->order->items_sorted }) {
1452 my $from_id = $::form->{converted_from_orderitems_ids}->[$idx];
1454 SL::DB::RecordLink->new(from_table => 'orderitems',
1455 from_id => $from_id,
1456 to_table => 'orderitems',
1464 }) || push(@{$errors}, $db->error);
1469 sub workflow_sales_or_purchase_order {
1472 my $errors = $self->save();
1474 if (scalar @{ $errors }) {
1475 $self->js->flash('error', $_) foreach @{ $errors };
1476 return $self->js->render();
1480 my $destination_type = $::form->{type} eq sales_quotation_type() ? sales_order_type()
1481 : $::form->{type} eq request_quotation_type() ? purchase_order_type()
1482 : $::form->{type} eq purchase_order_type() ? sales_order_type()
1483 : $::form->{type} eq sales_order_type() ? purchase_order_type()
1486 $self->order(SL::DB::Order->new_from($self->order, destination_type => $destination_type));
1487 $self->{converted_from_oe_id} = delete $::form->{id};
1489 # set item ids to new fake id, to identify them as new items
1490 foreach my $item (@{$self->order->items_sorted}) {
1491 $item->{new_fake_id} = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
1495 $::form->{type} = $destination_type;
1496 $self->type($self->init_type);
1497 $self->cv ($self->init_cv);
1501 $self->get_unalterable_data();
1502 $self->pre_render();
1504 # trigger rendering values for second row/longdescription as hidden,
1505 # because they are loaded only on demand. So we need to keep the values
1507 $_->{render_second_row} = 1 for @{ $self->order->items_sorted };
1508 $_->{render_longdescription} = 1 for @{ $self->order->items_sorted };
1512 title => $self->get_title_for('edit'),
1513 %{$self->{template_args}}
1521 $self->{all_taxzones} = SL::DB::Manager::TaxZone->get_all_sorted();
1522 $self->{all_departments} = SL::DB::Manager::Department->get_all_sorted();
1523 $self->{all_employees} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->employee_id,
1526 $self->{all_salesmen} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->salesman_id,
1529 $self->{all_payment_terms} = SL::DB::Manager::PaymentTerm->get_all_sorted(where => [ or => [ id => $self->order->payment_id,
1531 $self->{all_delivery_terms} = SL::DB::Manager::DeliveryTerm->get_all_sorted();
1532 $self->{current_employee_id} = SL::DB::Manager::Employee->current->id;
1533 $self->{periodic_invoices_status} = $self->get_periodic_invoices_status($self->order->periodic_invoices_config);
1534 $self->{order_probabilities} = [ map { { title => ($_ * 10) . '%', id => $_ * 10 } } (0..10) ];
1536 my $print_form = Form->new('');
1537 $print_form->{type} = $self->type;
1538 $print_form->{printers} = SL::DB::Manager::Printer->get_all_sorted;
1539 $print_form->{languages} = SL::DB::Manager::Language->get_all_sorted;
1540 $self->{print_options} = SL::Helper::PrintOptions->get_print_options(
1541 form => $print_form,
1542 options => {dialog_name_prefix => 'print_options.',
1546 no_opendocument => 0,
1550 foreach my $item (@{$self->order->orderitems}) {
1551 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
1552 $item->active_price_source( $price_source->price_from_source( $item->active_price_source ));
1553 $item->active_discount_source($price_source->discount_from_source($item->active_discount_source));
1556 if (any { $self->type eq $_ } (sales_order_type(), purchase_order_type())) {
1557 # calculate shipped qtys here to prevent calling calculate for every item via the items method
1558 SL::Helper::ShippedQty->new->calculate($self->order)->write_to_objects;
1561 if ($self->order->number && $::instance_conf->get_webdav) {
1562 my $webdav = SL::Webdav->new(
1563 type => $self->type,
1564 number => $self->order->number,
1566 my @all_objects = $webdav->get_all_objects;
1567 @{ $self->{template_args}->{WEBDAV} } = map { { name => $_->filename,
1569 link => File::Spec->catfile($_->full_filedescriptor),
1573 $::request->{layout}->use_javascript("${_}.js") for qw(kivi.SalesPurchase kivi.Order kivi.File ckeditor/ckeditor ckeditor/adapters/jquery edit_periodic_invoices_config calculate_qty);
1574 $self->setup_edit_action_bar;
1577 sub setup_edit_action_bar {
1578 my ($self, %params) = @_;
1580 my $deletion_allowed = (any { $self->type eq $_ } (sales_quotation_type(), request_quotation_type()))
1581 || (($self->type eq sales_order_type()) && $::instance_conf->get_sales_order_show_delete)
1582 || (($self->type eq purchase_order_type()) && $::instance_conf->get_purchase_order_show_delete);
1584 for my $bar ($::request->layout->get('actionbar')) {
1589 call => [ 'kivi.Order.save', 'save', $::instance_conf->get_order_warn_duplicate_parts,
1590 $::instance_conf->get_order_warn_no_deliverydate,
1592 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1596 call => [ 'kivi.Order.save', 'save_as_new', $::instance_conf->get_order_warn_duplicate_parts ],
1597 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1598 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1600 ], # end of combobox "Save"
1607 t8('Save and Sales Order'),
1608 submit => [ '#order_form', { action => "Order/sales_order" } ],
1609 only_if => (any { $self->type eq $_ } (sales_quotation_type(), purchase_order_type())),
1610 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1613 t8('Save and Purchase Order'),
1614 submit => [ '#order_form', { action => "Order/purchase_order" } ],
1615 only_if => (any { $self->type eq $_ } (sales_order_type(), request_quotation_type())),
1616 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1619 t8('Save and Delivery Order'),
1620 call => [ 'kivi.Order.save', 'save_and_delivery_order', $::instance_conf->get_order_warn_duplicate_parts,
1621 $::instance_conf->get_order_warn_no_deliverydate,
1623 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1624 only_if => (any { $self->type eq $_ } (sales_order_type(), purchase_order_type()))
1627 t8('Save and Invoice'),
1628 call => [ 'kivi.Order.save', 'save_and_invoice', $::instance_conf->get_order_warn_duplicate_parts ],
1629 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1631 ], # end of combobox "Workflow"
1638 t8('Save and print'),
1639 call => [ 'kivi.Order.show_print_options', $::instance_conf->get_order_warn_duplicate_parts ],
1642 t8('Save and E-mail'),
1643 call => [ 'kivi.Order.email', $::instance_conf->get_order_warn_duplicate_parts ],
1646 t8('Download attachments of all parts'),
1647 call => [ 'kivi.File.downloadOrderitemsFiles', $::form->{type}, $::form->{id} ],
1648 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1649 only_if => $::instance_conf->get_doc_storage,
1651 ], # end of combobox "Export"
1655 call => [ 'kivi.Order.delete_order' ],
1656 confirm => $::locale->text('Do you really want to delete this object?'),
1657 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1658 only_if => $deletion_allowed,
1665 my ($order, $pdf_ref, $params) = @_;
1669 my $print_form = Form->new('');
1670 $print_form->{type} = $order->type;
1671 $print_form->{formname} = $params->{formname} || $order->type;
1672 $print_form->{format} = $params->{format} || 'pdf';
1673 $print_form->{media} = $params->{media} || 'file';
1674 $print_form->{groupitems} = $params->{groupitems};
1675 $print_form->{media} = 'file' if $print_form->{media} eq 'screen';
1677 $order->language($params->{language});
1678 $order->flatten_to_form($print_form, format_amounts => 1);
1682 if ($print_form->{format} =~ /(opendocument|oasis)/i) {
1683 $template_ext = 'odt';
1684 $template_type = 'OpenDocument';
1687 # search for the template
1688 my ($template_file, @template_files) = SL::Helper::CreatePDF->find_template(
1689 name => $print_form->{formname},
1690 extension => $template_ext,
1691 email => $print_form->{media} eq 'email',
1692 language => $params->{language},
1693 printer_id => $print_form->{printer_id}, # todo
1696 if (!defined $template_file) {
1697 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);
1700 return @errors if scalar @errors;
1702 $print_form->throw_on_error(sub {
1704 $print_form->prepare_for_printing;
1706 $$pdf_ref = SL::Helper::CreatePDF->create_pdf(
1707 format => $print_form->{format},
1708 template_type => $template_type,
1709 template => $template_file,
1710 variables => $print_form,
1711 variable_content_types => {
1712 longdescription => 'html',
1713 partnotes => 'html',
1718 } || push @errors, ref($EVAL_ERROR) eq 'SL::X::FormError' ? $EVAL_ERROR->getMessage : $EVAL_ERROR;
1724 sub get_files_for_email_dialog {
1727 my %files = map { ($_ => []) } qw(versions files vc_files part_files);
1729 return %files if !$::instance_conf->get_doc_storage;
1731 if ($self->order->id) {
1732 $files{versions} = [ SL::File->get_all_versions(object_id => $self->order->id, object_type => $self->order->type, file_type => 'document') ];
1733 $files{files} = [ SL::File->get_all( object_id => $self->order->id, object_type => $self->order->type, file_type => 'attachment') ];
1734 $files{vc_files} = [ SL::File->get_all( object_id => $self->order->{$self->cv}->id, object_type => $self->cv, file_type => 'attachment') ];
1738 uniq_by { $_->{id} }
1740 +{ id => $_->part->id,
1741 partnumber => $_->part->partnumber }
1742 } @{$self->order->items_sorted};
1744 foreach my $part (@parts) {
1745 my @pfiles = SL::File->get_all(object_id => $part->{id}, object_type => 'part');
1746 push @{ $files{part_files} }, map { +{ %{ $_ }, partnumber => $part->{partnumber} } } @pfiles;
1749 foreach my $key (keys %files) {
1750 $files{$key} = [ sort_by { lc $_->{db_file}->{file_name} } @{ $files{$key} } ];
1756 sub make_periodic_invoices_config_from_yaml {
1757 my ($yaml_config) = @_;
1759 return if !$yaml_config;
1760 my $attr = YAML::Load($yaml_config);
1761 return if 'HASH' ne ref $attr;
1762 return SL::DB::PeriodicInvoicesConfig->new(%$attr);
1766 sub get_periodic_invoices_status {
1767 my ($self, $config) = @_;
1769 return if $self->type ne sales_order_type();
1770 return t8('not configured') if !$config;
1772 my $active = ('HASH' eq ref $config) ? $config->{active}
1773 : ('SL::DB::PeriodicInvoicesConfig' eq ref $config) ? $config->active
1774 : die "Cannot get status of periodic invoices config";
1776 return $active ? t8('active') : t8('inactive');
1780 my ($self, $action) = @_;
1782 return '' if none { lc($action)} qw(add edit);
1785 # $::locale->text("Add Sales Order");
1786 # $::locale->text("Add Purchase Order");
1787 # $::locale->text("Add Quotation");
1788 # $::locale->text("Add Request for Quotation");
1789 # $::locale->text("Edit Sales Order");
1790 # $::locale->text("Edit Purchase Order");
1791 # $::locale->text("Edit Quotation");
1792 # $::locale->text("Edit Request for Quotation");
1794 $action = ucfirst(lc($action));
1795 return $self->type eq sales_order_type() ? $::locale->text("$action Sales Order")
1796 : $self->type eq purchase_order_type() ? $::locale->text("$action Purchase Order")
1797 : $self->type eq sales_quotation_type() ? $::locale->text("$action Quotation")
1798 : $self->type eq request_quotation_type() ? $::locale->text("$action Request for Quotation")
1802 sub sales_order_type {
1806 sub purchase_order_type {
1810 sub sales_quotation_type {
1814 sub request_quotation_type {
1815 'request_quotation';
1819 return $_[0]->type eq sales_order_type() ? 'ordnumber'
1820 : $_[0]->type eq purchase_order_type() ? 'ordnumber'
1821 : $_[0]->type eq sales_quotation_type() ? 'quonumber'
1822 : $_[0]->type eq request_quotation_type() ? 'quonumber'
1834 SL::Controller::Order - controller for orders
1838 This is a new form to enter orders, completely rewritten with the use
1839 of controller and java script techniques.
1841 The aim is to provide the user a better expirience and a faster flow
1842 of work. Also the code should be more readable, more reliable and
1851 One input row, so that input happens every time at the same place.
1855 Use of pickers where possible.
1859 Possibility to enter more than one item at once.
1863 Item list in a scrollable area, so that the workflow buttons stay at
1868 Reordering item rows with drag and drop is possible. Sorting item rows is
1869 possible (by partnumber, description, qty, sellprice and discount for now).
1873 No C<update> is necessary. All entries and calculations are managed
1874 with ajax-calls and the page does only reload on C<save>.
1878 User can see changes immediately, because of the use of java script
1889 =item * C<SL/Controller/Order.pm>
1893 =item * C<template/webpages/order/form.html>
1897 =item * C<template/webpages/order/tabs/basic_data.html>
1899 Main tab for basic_data.
1901 This is the only tab here for now. "linked records" and "webdav" tabs are
1902 reused from generic code.
1906 =item * C<template/webpages/order/tabs/_business_info_row.html>
1908 For displaying information on business type
1910 =item * C<template/webpages/order/tabs/_item_input.html>
1912 The input line for items
1914 =item * C<template/webpages/order/tabs/_row.html>
1916 One row for already entered items
1918 =item * C<template/webpages/order/tabs/_tax_row.html>
1920 Displaying tax information
1922 =item * C<template/webpages/order/tabs/_multi_items_dialog.html>
1924 Dialog for entering more than one item at once
1926 =item * C<template/webpages/order/tabs/_multi_items_result.html>
1928 Results for the filter in the multi items dialog
1930 =item * C<template/webpages/order/tabs/_price_sources_dialog.html>
1932 Dialog for selecting price and discount sources
1936 =item * C<js/kivi.Order.js>
1938 java script functions
1950 =item * credit limit
1952 =item * more workflows (quotation, rfq)
1954 =item * price sources: little symbols showing better price / better discount
1956 =item * select units in input row?
1958 =item * custom shipto address
1960 =item * check for direct delivery (workflow sales order -> purchase order)
1962 =item * language / part translations
1964 =item * access rights
1966 =item * display weights
1972 =item * optional client/user behaviour
1974 (transactions has to be set - department has to be set -
1975 force project if enabled in client config - transport cost reminder)
1979 =head1 KNOWN BUGS AND CAVEATS
1985 Customer discount is not displayed as a valid discount in price source popup
1986 (this might be a bug in price sources)
1988 (I cannot reproduce this (Bernd))
1992 No indication that <shift>-up/down expands/collapses second row.
1996 Inline creation of parts is not currently supported
2000 Table header is not sticky in the scrolling area.
2004 Sorting does not include C<position>, neither does reordering.
2006 This behavior was implemented intentionally. But we can discuss, which behavior
2007 should be implemented.
2011 C<show_multi_items_dialog> does not use the currently inserted string for
2016 The language selected in print or email dialog is not saved when the order is saved.
2020 =head1 To discuss / Nice to have
2026 How to expand/collapse second row. Now it can be done clicking the icon or
2031 Possibility to change longdescription in input row?
2035 Possibility to select PriceSources in input row?
2039 This controller uses a (changed) copy of the template for the PriceSource
2040 dialog. Maybe there could be used one code source.
2044 Rounding-differences between this controller (PriceTaxCalculator) and the old
2045 form. This is not only a problem here, but also in all parts using the PTC.
2046 There exists a ticket and a patch. This patch should be testet.
2050 An indicator, if the actual inputs are saved (like in an
2051 editor or on text processing application).
2055 A warning when leaving the page without saveing unchanged inputs.
2062 Bernd Bleßmann E<lt>bernd@kivitendo-premium.deE<gt>