1 package SL::Controller::Order;
4 use parent qw(SL::Controller::Base);
6 use SL::Helper::Flash qw(flash_later);
7 use SL::Presenter::Tag qw(select_tag hidden_tag);
8 use SL::Locale::String qw(t8);
9 use SL::SessionFile::Random;
14 use SL::Util qw(trim);
20 use SL::DB::PartsGroup;
23 use SL::DB::RecordLink;
25 use SL::Helper::CreatePDF qw(:all);
26 use SL::Helper::PrintOptions;
27 use SL::Helper::ShippedQty;
28 use SL::Helper::UserPreferences::PositionsScrollbar;
29 use SL::Helper::UserPreferences::UpdatePositions;
31 use SL::Controller::Helper::GetModels;
33 use List::Util qw(first sum0);
34 use List::UtilsBy qw(sort_by uniq_by);
35 use List::MoreUtils qw(any none pairwise first_index);
36 use English qw(-no_match_vars);
41 use Rose::Object::MakeMethods::Generic
43 scalar => [ qw(item_ids_to_delete) ],
44 'scalar --get_set_init' => [ qw(order valid_types type cv p multi_items_models all_price_factors search_cvpartnumber show_update_button) ],
49 __PACKAGE__->run_before('check_auth');
51 __PACKAGE__->run_before('recalc',
52 only => [ qw(save save_as_new save_and_delivery_order save_and_invoice save_and_ap_transaction
55 __PACKAGE__->run_before('get_unalterable_data',
56 only => [ qw(save save_as_new save_and_delivery_order save_and_invoice save_and_ap_transaction
67 $self->order->transdate(DateTime->now_local());
68 my $extra_days = $self->{type} eq 'sales_quotation' ? $::instance_conf->get_reqdate_interval :
69 $self->{type} eq 'sales_order' ? $::instance_conf->get_delivery_date_interval : 1;
70 $self->order->reqdate(DateTime->today_local->next_workday(extra_days => $extra_days)) if !$self->order->reqdate;
76 title => $self->get_title_for('add'),
77 %{$self->{template_args}}
81 # edit an existing order
89 # this is to edit an order from an unsaved order object
91 # set item ids to new fake id, to identify them as new items
92 foreach my $item (@{$self->order->items_sorted}) {
93 $item->{new_fake_id} = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
95 # trigger rendering values for second row/longdescription as hidden,
96 # because they are loaded only on demand. So we need to keep the values
98 $_->{render_second_row} = 1 for @{ $self->order->items_sorted };
99 $_->{render_longdescription} = 1 for @{ $self->order->items_sorted };
106 title => $self->get_title_for('edit'),
107 %{$self->{template_args}}
111 # edit a collective order (consisting of one or more existing orders)
112 sub action_edit_collective {
116 my @multi_ids = map {
117 $_ =~ m{^multi_id_(\d+)$} && $::form->{'multi_id_' . $1} && $::form->{'trans_id_' . $1} && $::form->{'trans_id_' . $1}
118 } grep { $_ =~ m{^multi_id_\d+$} } keys %$::form;
120 # fall back to add if no ids are given
121 if (scalar @multi_ids == 0) {
126 # fall back to save as new if only one id is given
127 if (scalar @multi_ids == 1) {
128 $self->order(SL::DB::Order->new(id => $multi_ids[0])->load);
129 $self->action_save_as_new();
133 # make new order from given orders
134 my @multi_orders = map { SL::DB::Order->new(id => $_)->load } @multi_ids;
135 $self->{converted_from_oe_id} = join ' ', map { $_->id } @multi_orders;
136 $self->order(SL::DB::Order->new_from_multi(\@multi_orders, sort_sources_by => 'transdate'));
138 $self->action_edit();
145 my $errors = $self->delete();
147 if (scalar @{ $errors }) {
148 $self->js->flash('error', $_) foreach @{ $errors };
149 return $self->js->render();
152 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been deleted')
153 : $self->type eq purchase_order_type() ? $::locale->text('The order has been deleted')
154 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been deleted')
155 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been deleted')
157 flash_later('info', $text);
159 my @redirect_params = (
164 $self->redirect_to(@redirect_params);
171 my $errors = $self->save();
173 if (scalar @{ $errors }) {
174 $self->js->flash('error', $_) foreach @{ $errors };
175 return $self->js->render();
178 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
179 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
180 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
181 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
183 flash_later('info', $text);
185 my @redirect_params = (
188 id => $self->order->id,
191 $self->redirect_to(@redirect_params);
194 # save the order as new document an open it for edit
195 sub action_save_as_new {
198 my $order = $self->order;
201 $self->js->flash('error', t8('This object has not been saved yet.'));
202 return $self->js->render();
205 # load order from db to check if values changed
206 my $saved_order = SL::DB::Order->new(id => $order->id)->load;
209 # Lets assign a new number if the user hasn't changed the previous one.
210 # If it has been changed manually then use it as-is.
211 $new_attrs{number} = (trim($order->number) eq $saved_order->number)
213 : trim($order->number);
215 # Clear transdate unless changed
216 $new_attrs{transdate} = ($order->transdate == $saved_order->transdate)
217 ? DateTime->today_local
220 # Set new reqdate unless changed
221 if ($order->reqdate == $saved_order->reqdate) {
222 my $extra_days = $self->{type} eq 'sales_quotation' ? $::instance_conf->get_reqdate_interval :
223 $self->{type} eq 'sales_order' ? $::instance_conf->get_delivery_date_interval : 1;
224 $new_attrs{reqdate} = DateTime->today_local->next_workday(extra_days => $extra_days);
226 $new_attrs{reqdate} = $order->reqdate;
230 $new_attrs{employee} = SL::DB::Manager::Employee->current;
232 # Create new record from current one
233 $self->order(SL::DB::Order->new_from($order, destination_type => $order->type, attributes => \%new_attrs));
235 # no linked records on save as new
236 delete $::form->{$_} for qw(converted_from_oe_id converted_from_orderitems_ids);
239 $self->action_save();
244 # This is called if "print" is pressed in the print dialog.
245 # If PDF creation was requested and succeeded, the pdf is offered for download
246 # via send_file (which uses ajax in this case).
250 my $errors = $self->save();
252 if (scalar @{ $errors }) {
253 $self->js->flash('error', $_) foreach @{ $errors };
254 return $self->js->render();
257 $self->js_reset_order_and_item_ids_after_save;
259 my $format = $::form->{print_options}->{format};
260 my $media = $::form->{print_options}->{media};
261 my $formname = $::form->{print_options}->{formname};
262 my $copies = $::form->{print_options}->{copies};
263 my $groupitems = $::form->{print_options}->{groupitems};
265 # only pdf and opendocument by now
266 if (none { $format eq $_ } qw(pdf opendocument opendocument_pdf)) {
267 return $self->js->flash('error', t8('Format \'#1\' is not supported yet/anymore.', $format))->render;
270 # only screen or printer by now
271 if (none { $media eq $_ } qw(screen printer)) {
272 return $self->js->flash('error', t8('Media \'#1\' is not supported yet/anymore.', $media))->render;
276 $language = SL::DB::Language->new(id => $::form->{print_options}->{language_id})->load if $::form->{print_options}->{language_id};
278 # create a form for generate_attachment_filename
279 my $form = Form->new;
280 $form->{$self->nr_key()} = $self->order->number;
281 $form->{type} = $self->type;
282 $form->{format} = $format;
283 $form->{formname} = $formname;
284 $form->{language} = '_' . $language->template_code if $language;
285 my $pdf_filename = $form->generate_attachment_filename();
288 my @errors = generate_pdf($self->order, \$pdf, { format => $format,
289 formname => $formname,
290 language => $language,
291 groupitems => $groupitems });
292 if (scalar @errors) {
293 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render;
296 if ($media eq 'screen') {
298 $self->js->flash('info', t8('The PDF has been created'));
301 type => SL::MIME->mime_type_from_ext($pdf_filename),
302 name => $pdf_filename,
306 } elsif ($media eq 'printer') {
308 my $printer_id = $::form->{print_options}->{printer_id};
309 SL::DB::Printer->new(id => $printer_id)->load->print_document(
314 $self->js->flash('info', t8('The PDF has been printed'));
317 # copy file to webdav folder
318 if ($self->order->number && $::instance_conf->get_webdav_documents) {
319 my $webdav = SL::Webdav->new(
321 number => $self->order->number,
323 my $webdav_file = SL::Webdav::File->new(
325 filename => $pdf_filename,
328 $webdav_file->store(data => \$pdf);
331 $self->js->flash('error', t8('Storing PDF to webdav folder failed: #1', $@));
334 if ($self->order->number && $::instance_conf->get_doc_storage) {
336 SL::File->save(object_id => $self->order->id,
337 object_type => $self->type,
338 mime_type => 'application/pdf',
340 file_type => 'document',
341 file_name => $pdf_filename,
342 file_contents => $pdf);
345 $self->js->flash('error', t8('Storing PDF in storage backend failed: #1', $@));
351 # open the email dialog
352 sub action_show_email_dialog {
355 my $cv_method = $self->cv;
357 if (!$self->order->$cv_method) {
358 return $self->js->flash('error', $self->cv eq 'customer' ? t8('Cannot send E-mail without customer given') : t8('Cannot send E-mail without vendor given'))
363 $email_form->{to} = $self->order->contact->cp_email if $self->order->contact;
364 $email_form->{to} ||= $self->order->$cv_method->email;
365 $email_form->{cc} = $self->order->$cv_method->cc;
366 $email_form->{bcc} = join ', ', grep $_, $self->order->$cv_method->bcc, SL::DB::Default->get->global_bcc;
367 # Todo: get addresses from shipto, if any
369 my $form = Form->new;
370 $form->{$self->nr_key()} = $self->order->number;
371 $form->{formname} = $self->type;
372 $form->{type} = $self->type;
373 $form->{language} = '_' . $self->order->language->template_code if $self->order->language;
374 $form->{language_id} = $self->order->language->id if $self->order->language;
375 $form->{format} = 'pdf';
377 $email_form->{subject} = $form->generate_email_subject();
378 $email_form->{attachment_filename} = $form->generate_attachment_filename();
379 $email_form->{message} = $form->generate_email_body();
380 $email_form->{js_send_function} = 'kivi.Order.send_email()';
382 my %files = $self->get_files_for_email_dialog();
383 my $dialog_html = $self->render('common/_send_email_dialog', { output => 0 },
384 email_form => $email_form,
385 show_bcc => $::auth->assert('email_bcc', 'may fail'),
387 is_customer => $self->cv eq 'customer',
391 ->run('kivi.Order.show_email_dialog', $dialog_html)
398 # Todo: handling error messages: flash is not displayed in dialog, but in the main form
399 sub action_send_email {
402 my $errors = $self->save();
404 if (scalar @{ $errors }) {
405 $self->js->run('kivi.Order.close_email_dialog');
406 $self->js->flash('error', $_) foreach @{ $errors };
407 return $self->js->render();
410 $self->js_reset_order_and_item_ids_after_save;
412 my $email_form = delete $::form->{email_form};
413 my %field_names = (to => 'email');
415 $::form->{ $field_names{$_} // $_ } = $email_form->{$_} for keys %{ $email_form };
417 # for Form::cleanup which may be called in Form::send_email
418 $::form->{cwd} = getcwd();
419 $::form->{tmpdir} = $::lx_office_conf{paths}->{userspath};
421 $::form->{$_} = $::form->{print_options}->{$_} for keys %{ $::form->{print_options} };
422 $::form->{media} = 'email';
424 if (($::form->{attachment_policy} // '') !~ m{^(?:old_file|no_file)$}) {
426 $language = SL::DB::Language->new(id => $::form->{print_options}->{language_id})->load if $::form->{print_options}->{language_id};
429 my @errors = generate_pdf($self->order, \$pdf, {media => $::form->{media},
430 format => $::form->{print_options}->{format},
431 formname => $::form->{print_options}->{formname},
432 language => $language,
433 groupitems => $::form->{print_options}->{groupitems}});
434 if (scalar @errors) {
435 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
438 my $sfile = SL::SessionFile::Random->new(mode => "w");
439 $sfile->fh->print($pdf);
442 $::form->{tmpfile} = $sfile->file_name;
443 $::form->{tmpdir} = $sfile->get_path; # for Form::cleanup which may be called in Form::send_email
446 $::form->send_email(\%::myconfig, 'pdf');
449 my $intnotes = $self->order->intnotes;
450 $intnotes .= "\n\n" if $self->order->intnotes;
451 $intnotes .= t8('[email]') . "\n";
452 $intnotes .= t8('Date') . ": " . $::locale->format_date_object(DateTime->now_local, precision => 'seconds') . "\n";
453 $intnotes .= t8('To (email)') . ": " . $::form->{email} . "\n";
454 $intnotes .= t8('Cc') . ": " . $::form->{cc} . "\n" if $::form->{cc};
455 $intnotes .= t8('Bcc') . ": " . $::form->{bcc} . "\n" if $::form->{bcc};
456 $intnotes .= t8('Subject') . ": " . $::form->{subject} . "\n\n";
457 $intnotes .= t8('Message') . ": " . $::form->{message};
459 $self->order->update_attributes(intnotes => $intnotes);
462 ->val('#order_intnotes', $intnotes)
463 ->run('kivi.Order.close_email_dialog')
464 ->flash('info', t8('The email has been sent.'))
468 # open the periodic invoices config dialog
470 # If there are values in the form (i.e. dialog was opened before),
471 # then use this values. Create new ones, else.
472 sub action_show_periodic_invoices_config_dialog {
475 my $config = make_periodic_invoices_config_from_yaml(delete $::form->{config});
476 $config ||= SL::DB::Manager::PeriodicInvoicesConfig->find_by(oe_id => $::form->{id}) if $::form->{id};
477 $config ||= SL::DB::PeriodicInvoicesConfig->new(periodicity => 'm',
478 order_value_periodicity => 'p', # = same as periodicity
479 start_date_as_date => $::form->{transdate_as_date} || $::form->current_date,
480 extend_automatically_by => 12,
482 email_subject => GenericTranslations->get(
483 language_id => $::form->{language_id},
484 translation_type =>"preset_text_periodic_invoices_email_subject"),
485 email_body => GenericTranslations->get(
486 language_id => $::form->{language_id},
487 translation_type =>"preset_text_periodic_invoices_email_body"),
489 $config->periodicity('m') if none { $_ eq $config->periodicity } @SL::DB::PeriodicInvoicesConfig::PERIODICITIES;
490 $config->order_value_periodicity('p') if none { $_ eq $config->order_value_periodicity } ('p', @SL::DB::PeriodicInvoicesConfig::ORDER_VALUE_PERIODICITIES);
492 $::form->get_lists(printers => "ALL_PRINTERS",
493 charts => { key => 'ALL_CHARTS',
494 transdate => 'current_date' });
496 $::form->{AR} = [ grep { $_->{link} =~ m/(?:^|:)AR(?::|$)/ } @{ $::form->{ALL_CHARTS} } ];
498 if ($::form->{customer_id}) {
499 $::form->{ALL_CONTACTS} = SL::DB::Manager::Contact->get_all_sorted(where => [ cp_cv_id => $::form->{customer_id} ]);
500 $::form->{email_recipient_invoice_address} = SL::DB::Manager::Customer->find_by(id => $::form->{customer_id})->invoice_mail;
503 $self->render('oe/edit_periodic_invoices_config', { layout => 0 },
505 popup_js_close_function => 'kivi.Order.close_periodic_invoices_config_dialog()',
506 popup_js_assign_function => 'kivi.Order.assign_periodic_invoices_config()',
511 # assign the values of the periodic invoices config dialog
512 # as yaml in the hidden tag and set the status.
513 sub action_assign_periodic_invoices_config {
516 $::form->isblank('start_date_as_date', $::locale->text('The start date is missing.'));
518 my $config = { active => $::form->{active} ? 1 : 0,
519 terminated => $::form->{terminated} ? 1 : 0,
520 direct_debit => $::form->{direct_debit} ? 1 : 0,
521 periodicity => (any { $_ eq $::form->{periodicity} } @SL::DB::PeriodicInvoicesConfig::PERIODICITIES) ? $::form->{periodicity} : 'm',
522 order_value_periodicity => (any { $_ eq $::form->{order_value_periodicity} } ('p', @SL::DB::PeriodicInvoicesConfig::ORDER_VALUE_PERIODICITIES)) ? $::form->{order_value_periodicity} : 'p',
523 start_date_as_date => $::form->{start_date_as_date},
524 end_date_as_date => $::form->{end_date_as_date},
525 first_billing_date_as_date => $::form->{first_billing_date_as_date},
526 print => $::form->{print} ? 1 : 0,
527 printer_id => $::form->{print} ? $::form->{printer_id} * 1 : undef,
528 copies => $::form->{copies} * 1 ? $::form->{copies} : 1,
529 extend_automatically_by => $::form->{extend_automatically_by} * 1 || undef,
530 ar_chart_id => $::form->{ar_chart_id} * 1,
531 send_email => $::form->{send_email} ? 1 : 0,
532 email_recipient_contact_id => $::form->{email_recipient_contact_id} * 1 || undef,
533 email_recipient_address => $::form->{email_recipient_address},
534 email_sender => $::form->{email_sender},
535 email_subject => $::form->{email_subject},
536 email_body => $::form->{email_body},
539 my $periodic_invoices_config = SL::YAML::Dump($config);
541 my $status = $self->get_periodic_invoices_status($config);
544 ->remove('#order_periodic_invoices_config')
545 ->insertAfter(hidden_tag('order.periodic_invoices_config', $periodic_invoices_config), '#periodic_invoices_status')
546 ->run('kivi.Order.close_periodic_invoices_config_dialog')
547 ->html('#periodic_invoices_status', $status)
548 ->flash('info', t8('The periodic invoices config has been assigned.'))
552 sub action_get_has_active_periodic_invoices {
555 my $config = make_periodic_invoices_config_from_yaml(delete $::form->{config});
556 $config ||= SL::DB::Manager::PeriodicInvoicesConfig->find_by(oe_id => $::form->{id}) if $::form->{id};
558 my $has_active_periodic_invoices =
559 $self->type eq sales_order_type()
562 && (!$config->end_date || ($config->end_date > DateTime->today_local))
563 && $config->get_previous_billed_period_start_date;
565 $_[0]->render(\ !!$has_active_periodic_invoices, { type => 'text' });
568 # save the order and redirect to the frontend subroutine for a new
570 sub action_save_and_delivery_order {
573 my $errors = $self->save();
575 if (scalar @{ $errors }) {
576 $self->js->flash('error', $_) foreach @{ $errors };
577 return $self->js->render();
580 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
581 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
582 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
583 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
585 flash_later('info', $text);
587 my @redirect_params = (
588 controller => 'oe.pl',
589 action => 'oe_delivery_order_from_order',
590 id => $self->order->id,
593 $self->redirect_to(@redirect_params);
596 # save the order and redirect to the frontend subroutine for a new
598 sub action_save_and_invoice {
601 my $errors = $self->save();
603 if (scalar @{ $errors }) {
604 $self->js->flash('error', $_) foreach @{ $errors };
605 return $self->js->render();
608 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
609 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
610 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
611 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
613 flash_later('info', $text);
615 my @redirect_params = (
616 controller => 'oe.pl',
617 action => 'oe_invoice_from_order',
618 id => $self->order->id,
621 $self->redirect_to(@redirect_params);
624 # workflow from sales quotation to sales order
625 sub action_sales_order {
626 $_[0]->workflow_sales_or_purchase_order();
629 # workflow from rfq to purchase order
630 sub action_purchase_order {
631 $_[0]->workflow_sales_or_purchase_order();
634 # workflow from purchase order to ap transaction
635 sub action_save_and_ap_transaction {
638 my $errors = $self->save();
640 if (scalar @{ $errors }) {
641 $self->js->flash('error', $_) foreach @{ $errors };
642 return $self->js->render();
645 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
646 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
647 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
648 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
650 flash_later('info', $text);
652 my @redirect_params = (
653 controller => 'ap.pl',
654 action => 'add_from_purchase_order',
655 id => $self->order->id,
658 $self->redirect_to(@redirect_params);
661 # set form elements in respect to a changed customer or vendor
663 # This action is called on an change of the customer/vendor picker.
664 sub action_customer_vendor_changed {
667 setup_order_from_cv($self->order);
670 my $cv_method = $self->cv;
672 if ($self->order->$cv_method->contacts && scalar @{ $self->order->$cv_method->contacts } > 0) {
673 $self->js->show('#cp_row');
675 $self->js->hide('#cp_row');
678 if ($self->order->$cv_method->shipto && scalar @{ $self->order->$cv_method->shipto } > 0) {
679 $self->js->show('#shipto_row');
681 $self->js->hide('#shipto_row');
684 $self->js->val( '#order_salesman_id', $self->order->salesman_id) if $self->order->is_sales;
687 ->replaceWith('#order_cp_id', $self->build_contact_select)
688 ->replaceWith('#order_shipto_id', $self->build_shipto_select)
689 ->replaceWith('#business_info_row', $self->build_business_info_row)
690 ->val( '#order_taxzone_id', $self->order->taxzone_id)
691 ->val( '#order_taxincluded', $self->order->taxincluded)
692 ->val( '#order_payment_id', $self->order->payment_id)
693 ->val( '#order_delivery_term_id', $self->order->delivery_term_id)
694 ->val( '#order_intnotes', $self->order->intnotes)
695 ->val( '#language_id', $self->order->$cv_method->language_id)
696 ->focus( '#order_' . $self->cv . '_id');
698 $self->js_redisplay_amounts_and_taxes;
699 $self->js_redisplay_cvpartnumbers;
703 # open the dialog for customer/vendor details
704 sub action_show_customer_vendor_details_dialog {
707 my $is_customer = 'customer' eq $::form->{vc};
710 $cv = SL::DB::Customer->new(id => $::form->{vc_id})->load;
712 $cv = SL::DB::Vendor->new(id => $::form->{vc_id})->load;
715 my %details = map { $_ => $cv->$_ } @{$cv->meta->columns};
716 $details{discount_as_percent} = $cv->discount_as_percent;
717 $details{creditlimt} = $cv->creditlimit_as_number;
718 $details{business} = $cv->business->description if $cv->business;
719 $details{language} = $cv->language_obj->description if $cv->language_obj;
720 $details{delivery_terms} = $cv->delivery_term->description if $cv->delivery_term;
721 $details{payment_terms} = $cv->payment->description if $cv->payment;
722 $details{pricegroup} = $cv->pricegroup->pricegroup if $is_customer && $cv->pricegroup;
724 foreach my $entry (@{ $cv->shipto }) {
725 push @{ $details{SHIPTO} }, { map { $_ => $entry->$_ } @{$entry->meta->columns} };
727 foreach my $entry (@{ $cv->contacts }) {
728 push @{ $details{CONTACTS} }, { map { $_ => $entry->$_ } @{$entry->meta->columns} };
731 $_[0]->render('common/show_vc_details', { layout => 0 },
732 is_customer => $is_customer,
737 # called if a unit in an existing item row is changed
738 sub action_unit_changed {
741 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
742 my $item = $self->order->items_sorted->[$idx];
744 my $old_unit_obj = SL::DB::Unit->new(name => $::form->{old_unit})->load;
745 $item->sellprice($item->unit_obj->convert_to($item->sellprice, $old_unit_obj));
750 ->run('kivi.Order.update_sellprice', $::form->{item_id}, $item->sellprice_as_number);
751 $self->js_redisplay_line_values;
752 $self->js_redisplay_amounts_and_taxes;
756 # add an item row for a new item entered in the input row
757 sub action_add_item {
760 my $form_attr = $::form->{add_item};
762 return unless $form_attr->{parts_id};
764 my $item = new_item($self->order, $form_attr);
766 $self->order->add_items($item);
770 $self->get_item_cvpartnumber($item);
772 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
773 my $row_as_html = $self->p->render('order/tabs/_row',
779 if ($::form->{insert_before_item_id}) {
781 ->before ('.row_entry:has(#item_' . $::form->{insert_before_item_id} . ')', $row_as_html);
784 ->append('#row_table_id', $row_as_html);
787 if ( $item->part->is_assortment ) {
788 $form_attr->{qty_as_number} = 1 unless $form_attr->{qty_as_number};
789 foreach my $assortment_item ( @{$item->part->assortment_items} ) {
790 my $attr = { parts_id => $assortment_item->parts_id,
791 qty => $assortment_item->qty * $::form->parse_amount(\%::myconfig, $form_attr->{qty_as_number}), # TODO $form_attr->{unit}
792 unit => $assortment_item->unit,
793 description => $assortment_item->part->description,
795 my $item = new_item($self->order, $attr);
797 # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount
798 $item->discount(1) unless $assortment_item->charge;
800 $self->order->add_items( $item );
802 $self->get_item_cvpartnumber($item);
803 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
804 my $row_as_html = $self->p->render('order/tabs/_row',
809 if ($::form->{insert_before_item_id}) {
811 ->before ('.row_entry:has(#item_' . $::form->{insert_before_item_id} . ')', $row_as_html);
814 ->append('#row_table_id', $row_as_html);
820 ->val('.add_item_input', '')
821 ->run('kivi.Order.init_row_handlers')
822 ->run('kivi.Order.renumber_positions')
823 ->focus('#add_item_parts_id_name');
825 $self->js->run('kivi.Order.row_table_scroll_down') if !$::form->{insert_before_item_id};
827 $self->js_redisplay_amounts_and_taxes;
831 # open the dialog for entering multiple items at once
832 sub action_show_multi_items_dialog {
833 $_[0]->render('order/tabs/_multi_items_dialog', { layout => 0 },
834 all_partsgroups => SL::DB::Manager::PartsGroup->get_all);
837 # update the filter results in the multi item dialog
838 sub action_multi_items_update_result {
841 $::form->{multi_items}->{filter}->{obsolete} = 0;
843 my $count = $_[0]->multi_items_models->count;
846 my $text = SL::Presenter::EscapedText->new(text => $::locale->text('No results.'));
847 $_[0]->render($text, { layout => 0 });
848 } elsif ($count > $max_count) {
849 my $text = SL::Presenter::EscapedText->new(text => $::locale->text('Too many results (#1 from #2).', $count, $max_count));
850 $_[0]->render($text, { layout => 0 });
852 my $multi_items = $_[0]->multi_items_models->get;
853 $_[0]->render('order/tabs/_multi_items_result', { layout => 0 },
854 multi_items => $multi_items);
858 # add item rows for multiple items at once
859 sub action_add_multi_items {
862 my @form_attr = grep { $_->{qty_as_number} } @{ $::form->{add_multi_items} };
863 return $self->js->render() unless scalar @form_attr;
866 foreach my $attr (@form_attr) {
867 my $item = new_item($self->order, $attr);
869 if ( $item->part->is_assortment ) {
870 foreach my $assortment_item ( @{$item->part->assortment_items} ) {
871 my $attr = { parts_id => $assortment_item->parts_id,
872 qty => $assortment_item->qty * $item->qty, # TODO $form_attr->{unit}
873 unit => $assortment_item->unit,
874 description => $assortment_item->part->description,
876 my $item = new_item($self->order, $attr);
878 # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount
879 $item->discount(1) unless $assortment_item->charge;
884 $self->order->add_items(@items);
888 foreach my $item (@items) {
889 $self->get_item_cvpartnumber($item);
890 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
891 my $row_as_html = $self->p->render('order/tabs/_row',
897 if ($::form->{insert_before_item_id}) {
899 ->before ('.row_entry:has(#item_' . $::form->{insert_before_item_id} . ')', $row_as_html);
902 ->append('#row_table_id', $row_as_html);
907 ->run('kivi.Order.close_multi_items_dialog')
908 ->run('kivi.Order.init_row_handlers')
909 ->run('kivi.Order.renumber_positions')
910 ->focus('#add_item_parts_id_name');
912 $self->js->run('kivi.Order.row_table_scroll_down') if !$::form->{insert_before_item_id};
914 $self->js_redisplay_amounts_and_taxes;
918 # recalculate all linetotals, amounts and taxes and redisplay them
919 sub action_recalc_amounts_and_taxes {
924 $self->js_redisplay_line_values;
925 $self->js_redisplay_amounts_and_taxes;
929 sub action_update_exchangerate {
932 if ($self->order->currency_id != $::instance_conf->get_currency_id) {
934 currency_name => $self->order->currency->name,
935 exchangerate => $self->order->exchangerate_as_number,
938 $self->render(\SL::JSON::to_json($data), { type => 'json', process => 0 });
941 # redisplay item rows if they are sorted by an attribute
942 sub action_reorder_items {
946 partnumber => sub { $_[0]->part->partnumber },
947 description => sub { $_[0]->description },
948 qty => sub { $_[0]->qty },
949 sellprice => sub { $_[0]->sellprice },
950 discount => sub { $_[0]->discount },
951 cvpartnumber => sub { $_[0]->{cvpartnumber} },
954 $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
956 my $method = $sort_keys{$::form->{order_by}};
957 my @to_sort = map { { old_pos => $_->position, order_by => $method->($_) } } @{ $self->order->items_sorted };
958 if ($::form->{sort_dir}) {
959 if ( $::form->{order_by} =~ m/qty|sellprice|discount/ ){
960 @to_sort = sort { $a->{order_by} <=> $b->{order_by} } @to_sort;
962 @to_sort = sort { $a->{order_by} cmp $b->{order_by} } @to_sort;
965 if ( $::form->{order_by} =~ m/qty|sellprice|discount/ ){
966 @to_sort = sort { $b->{order_by} <=> $a->{order_by} } @to_sort;
968 @to_sort = sort { $b->{order_by} cmp $a->{order_by} } @to_sort;
972 ->run('kivi.Order.redisplay_items', \@to_sort)
976 # show the popup to choose a price/discount source
977 sub action_price_popup {
980 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
981 my $item = $self->order->items_sorted->[$idx];
983 $self->render_price_dialog($item);
986 # get the longdescription for an item if the dialog to enter/change the
987 # longdescription was opened and the longdescription is empty
989 # If this item is new, get the longdescription from Part.
990 # Otherwise get it from OrderItem.
991 sub action_get_item_longdescription {
994 if ($::form->{item_id}) {
995 $longdescription = SL::DB::OrderItem->new(id => $::form->{item_id})->load->longdescription;
996 } elsif ($::form->{parts_id}) {
997 $longdescription = SL::DB::Part->new(id => $::form->{parts_id})->load->notes;
999 $_[0]->render(\ $longdescription, { type => 'text' });
1002 # load the second row for one or more items
1004 # This action gets the html code for all items second rows by rendering a template for
1005 # the second row and sets the html code via client js.
1006 sub action_load_second_rows {
1009 $self->recalc() if $self->order->is_sales; # for margin calculation
1011 foreach my $item_id (@{ $::form->{item_ids} }) {
1012 my $idx = first_index { $_ eq $item_id } @{ $::form->{orderitem_ids} };
1013 my $item = $self->order->items_sorted->[$idx];
1015 $self->js_load_second_row($item, $item_id, 0);
1018 $self->js->run('kivi.Order.init_row_handlers') if $self->order->is_sales; # for lastcosts change-callback
1020 $self->js->render();
1023 # update description, notes and sellprice from master data
1024 sub action_update_row_from_master_data {
1027 foreach my $item_id (@{ $::form->{item_ids} }) {
1028 my $idx = first_index { $_ eq $item_id } @{ $::form->{orderitem_ids} };
1029 my $item = $self->order->items_sorted->[$idx];
1031 $item->description($item->part->description);
1032 $item->longdescription($item->part->notes);
1034 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
1037 if ($item->part->is_assortment) {
1038 # add assortment items with price 0, as the components carry the price
1039 $price_src = $price_source->price_from_source("");
1040 $price_src->price(0);
1042 $price_src = $price_source->best_price
1043 ? $price_source->best_price
1044 : $price_source->price_from_source("");
1045 $price_src->price(0) if !$price_source->best_price;
1048 $item->sellprice($price_src->price);
1049 $item->active_price_source($price_src);
1052 ->run('kivi.Order.update_sellprice', $item_id, $item->sellprice_as_number)
1053 ->html('.row_entry:has(#item_' . $item_id . ') [name = "partnumber"] a', $item->part->partnumber)
1054 ->val ('.row_entry:has(#item_' . $item_id . ') [name = "order.orderitems[].description"]', $item->description)
1055 ->val ('.row_entry:has(#item_' . $item_id . ') [name = "order.orderitems[].longdescription"]', $item->longdescription);
1057 if ($self->search_cvpartnumber) {
1058 $self->get_item_cvpartnumber($item);
1059 $self->js->html('.row_entry:has(#item_' . $item_id . ') [name = "cvpartnumber"]', $item->{cvpartnumber});
1064 $self->js_redisplay_line_values;
1065 $self->js_redisplay_amounts_and_taxes;
1067 $self->js->render();
1070 sub js_load_second_row {
1071 my ($self, $item, $item_id, $do_parse) = @_;
1074 # Parse values from form (they are formated while rendering (template)).
1075 # Workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
1076 # This parsing is not necessary at all, if we assure that the second row/cvars are only loaded once.
1077 foreach my $var (@{ $item->cvars_by_config }) {
1078 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
1080 $item->parse_custom_variable_values;
1083 my $row_as_html = $self->p->render('order/tabs/_second_row', ITEM => $item, TYPE => $self->type);
1086 ->html('#second_row_' . $item_id, $row_as_html)
1087 ->data('#second_row_' . $item_id, 'loaded', 1);
1090 sub js_redisplay_line_values {
1093 my $is_sales = $self->order->is_sales;
1095 # sales orders with margins
1100 $::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0),
1101 $::form->format_amount(\%::myconfig, $_->{marge_total}, 2, 0),
1102 $::form->format_amount(\%::myconfig, $_->{marge_percent}, 2, 0),
1103 ]} @{ $self->order->items_sorted };
1107 $::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0),
1108 ]} @{ $self->order->items_sorted };
1112 ->run('kivi.Order.redisplay_line_values', $is_sales, \@data);
1115 sub js_redisplay_amounts_and_taxes {
1118 if (scalar @{ $self->{taxes} }) {
1119 $self->js->show('#taxincluded_row_id');
1121 $self->js->hide('#taxincluded_row_id');
1124 if ($self->order->taxincluded) {
1125 $self->js->hide('#subtotal_row_id');
1127 $self->js->show('#subtotal_row_id');
1130 if ($self->order->is_sales) {
1131 my $is_neg = $self->order->marge_total < 0;
1133 ->html('#marge_total_id', $::form->format_amount(\%::myconfig, $self->order->marge_total, 2))
1134 ->html('#marge_percent_id', $::form->format_amount(\%::myconfig, $self->order->marge_percent, 2))
1135 ->action_if( $is_neg, 'addClass', '#marge_total_id', 'plus0')
1136 ->action_if( $is_neg, 'addClass', '#marge_percent_id', 'plus0')
1137 ->action_if( $is_neg, 'addClass', '#marge_percent_sign_id', 'plus0')
1138 ->action_if(!$is_neg, 'removeClass', '#marge_total_id', 'plus0')
1139 ->action_if(!$is_neg, 'removeClass', '#marge_percent_id', 'plus0')
1140 ->action_if(!$is_neg, 'removeClass', '#marge_percent_sign_id', 'plus0');
1144 ->html('#netamount_id', $::form->format_amount(\%::myconfig, $self->order->netamount, -2))
1145 ->html('#amount_id', $::form->format_amount(\%::myconfig, $self->order->amount, -2))
1146 ->remove('.tax_row')
1147 ->insertBefore($self->build_tax_rows, '#amount_row_id');
1150 sub js_redisplay_cvpartnumbers {
1153 $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
1155 my @data = map {[$_->{cvpartnumber}]} @{ $self->order->items_sorted };
1158 ->run('kivi.Order.redisplay_cvpartnumbers', \@data);
1161 sub js_reset_order_and_item_ids_after_save {
1165 ->val('#id', $self->order->id)
1166 ->val('#converted_from_oe_id', '')
1167 ->val('#order_' . $self->nr_key(), $self->order->number);
1170 foreach my $form_item_id (@{ $::form->{orderitem_ids} }) {
1171 next if !$self->order->items_sorted->[$idx]->id;
1172 next if $form_item_id !~ m{^new};
1174 ->val ('[name="orderitem_ids[+]"][value="' . $form_item_id . '"]', $self->order->items_sorted->[$idx]->id)
1175 ->val ('#item_' . $form_item_id, $self->order->items_sorted->[$idx]->id)
1176 ->attr('#item_' . $form_item_id, "id", 'item_' . $self->order->items_sorted->[$idx]->id);
1180 $self->js->val('[name="converted_from_orderitems_ids[+]"]', '');
1187 sub init_valid_types {
1188 [ sales_order_type(), purchase_order_type(), sales_quotation_type(), request_quotation_type() ];
1194 if (none { $::form->{type} eq $_ } @{$self->valid_types}) {
1195 die "Not a valid type for order";
1198 $self->type($::form->{type});
1204 my $cv = (any { $self->type eq $_ } (sales_order_type(), sales_quotation_type())) ? 'customer'
1205 : (any { $self->type eq $_ } (purchase_order_type(), request_quotation_type())) ? 'vendor'
1206 : die "Not a valid type for order";
1211 sub init_search_cvpartnumber {
1214 my $user_prefs = SL::Helper::UserPreferences::PartPickerSearch->new();
1215 my $search_cvpartnumber;
1216 $search_cvpartnumber = !!$user_prefs->get_sales_search_customer_partnumber() if $self->cv eq 'customer';
1217 $search_cvpartnumber = !!$user_prefs->get_purchase_search_makemodel() if $self->cv eq 'vendor';
1219 return $search_cvpartnumber;
1222 sub init_show_update_button {
1225 !!SL::Helper::UserPreferences::UpdatePositions->new()->get_show_update_button();
1236 # model used to filter/display the parts in the multi-items dialog
1237 sub init_multi_items_models {
1238 SL::Controller::Helper::GetModels->new(
1239 controller => $_[0],
1241 with_objects => [ qw(unit_obj) ],
1242 disable_plugin => 'paginated',
1243 source => $::form->{multi_items},
1249 partnumber => t8('Partnumber'),
1250 description => t8('Description')}
1254 sub init_all_price_factors {
1255 SL::DB::Manager::PriceFactor->get_all;
1261 my $right_for = { map { $_ => $_.'_edit' } @{$self->valid_types} };
1263 my $right = $right_for->{ $self->type };
1264 $right ||= 'DOES_NOT_EXIST';
1266 $::auth->assert($right);
1269 # build the selection box for contacts
1271 # Needed, if customer/vendor changed.
1272 sub build_contact_select {
1275 select_tag('order.cp_id', [ $self->order->{$self->cv}->contacts ],
1276 value_key => 'cp_id',
1277 title_key => 'full_name_dep',
1278 default => $self->order->cp_id,
1280 style => 'width: 300px',
1284 # build the selection box for shiptos
1286 # Needed, if customer/vendor changed.
1287 sub build_shipto_select {
1290 select_tag('order.shipto_id', [ $self->order->{$self->cv}->shipto ],
1291 value_key => 'shipto_id',
1292 title_key => 'displayable_id',
1293 default => $self->order->shipto_id,
1295 style => 'width: 300px',
1299 # render the info line for business
1301 # Needed, if customer/vendor changed.
1302 sub build_business_info_row
1304 $_[0]->p->render('order/tabs/_business_info_row', SELF => $_[0]);
1307 # build the rows for displaying taxes
1309 # Called if amounts where recalculated and redisplayed.
1310 sub build_tax_rows {
1314 foreach my $tax (sort { $a->{tax}->rate cmp $b->{tax}->rate } @{ $self->{taxes} }) {
1315 $rows_as_html .= $self->p->render('order/tabs/_tax_row', TAX => $tax, TAXINCLUDED => $self->order->taxincluded);
1317 return $rows_as_html;
1321 sub render_price_dialog {
1322 my ($self, $record_item) = @_;
1324 my $price_source = SL::PriceSource->new(record_item => $record_item, record => $self->order);
1328 'kivi.io.price_chooser_dialog',
1329 t8('Available Prices'),
1330 $self->render('order/tabs/_price_sources_dialog', { output => 0 }, price_source => $price_source)
1335 # $self->js->text('#dialog_flash_error_content', join ' ', @errors);
1336 # $self->js->show('#dialog_flash_error');
1345 return if !$::form->{id};
1347 $self->order(SL::DB::Order->new(id => $::form->{id})->load);
1350 # load or create a new order object
1352 # And assign changes from the form to this object.
1353 # If the order is loaded from db, check if items are deleted in the form,
1354 # remove them form the object and collect them for removing from db on saving.
1355 # Then create/update items from form (via make_item) and add them.
1359 # add_items adds items to an order with no items for saving, but they cannot
1360 # be retrieved via items until the order is saved. Adding empty items to new
1361 # order here solves this problem.
1363 $order = SL::DB::Order->new(id => $::form->{id})->load(with => [ 'orderitems', 'orderitems.part' ]) if $::form->{id};
1364 $order ||= SL::DB::Order->new(orderitems => [],
1365 quotation => (any { $self->type eq $_ } (sales_quotation_type(), request_quotation_type())));
1367 my $cv_id_method = $self->cv . '_id';
1368 if (!$::form->{id} && $::form->{$cv_id_method}) {
1369 $order->$cv_id_method($::form->{$cv_id_method});
1370 setup_order_from_cv($order);
1373 my $form_orderitems = delete $::form->{order}->{orderitems};
1374 my $form_periodic_invoices_config = delete $::form->{order}->{periodic_invoices_config};
1376 $order->assign_attributes(%{$::form->{order}});
1378 if (my $periodic_invoices_config_attrs = $form_periodic_invoices_config ? SL::YAML::Load($form_periodic_invoices_config) : undef) {
1379 my $periodic_invoices_config = $order->periodic_invoices_config || $order->periodic_invoices_config(SL::DB::PeriodicInvoicesConfig->new);
1380 $periodic_invoices_config->assign_attributes(%$periodic_invoices_config_attrs);
1383 # remove deleted items
1384 $self->item_ids_to_delete([]);
1385 foreach my $idx (reverse 0..$#{$order->orderitems}) {
1386 my $item = $order->orderitems->[$idx];
1387 if (none { $item->id == $_->{id} } @{$form_orderitems}) {
1388 splice @{$order->orderitems}, $idx, 1;
1389 push @{$self->item_ids_to_delete}, $item->id;
1395 foreach my $form_attr (@{$form_orderitems}) {
1396 my $item = make_item($order, $form_attr);
1397 $item->position($pos);
1401 $order->add_items(grep {!$_->id} @items);
1406 # create or update items from form
1408 # Make item objects from form values. For items already existing read from db.
1409 # Create a new item else. And assign attributes.
1411 my ($record, $attr) = @_;
1414 $item = first { $_->id == $attr->{id} } @{$record->items} if $attr->{id};
1416 my $is_new = !$item;
1418 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
1419 # they cannot be retrieved via custom_variables until the order/orderitem is
1420 # saved. Adding empty custom_variables to new orderitem here solves this problem.
1421 $item ||= SL::DB::OrderItem->new(custom_variables => []);
1423 $item->assign_attributes(%$attr);
1424 $item->longdescription($item->part->notes) if $is_new && !defined $attr->{longdescription};
1425 $item->project_id($record->globalproject_id) if $is_new && !defined $attr->{project_id};
1426 $item->lastcost($record->is_sales ? $item->part->lastcost : 0) if $is_new && !defined $attr->{lastcost_as_number};
1433 # This is used to add one item
1435 my ($record, $attr) = @_;
1437 my $item = SL::DB::OrderItem->new;
1439 # Remove attributes where the user left or set the inputs empty.
1440 # So these attributes will be undefined and we can distinguish them
1441 # from zero later on.
1442 for (qw(qty_as_number sellprice_as_number discount_as_percent)) {
1443 delete $attr->{$_} if $attr->{$_} eq '';
1446 $item->assign_attributes(%$attr);
1448 my $part = SL::DB::Part->new(id => $attr->{parts_id})->load;
1449 my $price_source = SL::PriceSource->new(record_item => $item, record => $record);
1451 $item->unit($part->unit) if !$item->unit;
1454 if ( $part->is_assortment ) {
1455 # add assortment items with price 0, as the components carry the price
1456 $price_src = $price_source->price_from_source("");
1457 $price_src->price(0);
1458 } elsif (defined $item->sellprice) {
1459 $price_src = $price_source->price_from_source("");
1460 $price_src->price($item->sellprice);
1462 $price_src = $price_source->best_price
1463 ? $price_source->best_price
1464 : $price_source->price_from_source("");
1465 $price_src->price(0) if !$price_source->best_price;
1469 if (defined $item->discount) {
1470 $discount_src = $price_source->discount_from_source("");
1471 $discount_src->discount($item->discount);
1473 $discount_src = $price_source->best_discount
1474 ? $price_source->best_discount
1475 : $price_source->discount_from_source("");
1476 $discount_src->discount(0) if !$price_source->best_discount;
1480 $new_attr{part} = $part;
1481 $new_attr{description} = $part->description if ! $item->description;
1482 $new_attr{qty} = 1.0 if ! $item->qty;
1483 $new_attr{price_factor_id} = $part->price_factor_id if ! $item->price_factor_id;
1484 $new_attr{sellprice} = $price_src->price;
1485 $new_attr{discount} = $discount_src->discount;
1486 $new_attr{active_price_source} = $price_src;
1487 $new_attr{active_discount_source} = $discount_src;
1488 $new_attr{longdescription} = $part->notes if ! defined $attr->{longdescription};
1489 $new_attr{project_id} = $record->globalproject_id;
1490 $new_attr{lastcost} = $record->is_sales ? $part->lastcost : 0;
1492 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
1493 # they cannot be retrieved via custom_variables until the order/orderitem is
1494 # saved. Adding empty custom_variables to new orderitem here solves this problem.
1495 $new_attr{custom_variables} = [];
1497 $item->assign_attributes(%new_attr);
1502 sub setup_order_from_cv {
1505 $order->$_($order->customervendor->$_) for (qw(taxzone_id payment_id delivery_term_id));
1507 $order->intnotes($order->customervendor->notes);
1509 if ($order->is_sales) {
1510 $order->salesman_id($order->customer->salesman_id || SL::DB::Manager::Employee->current->id);
1511 $order->taxincluded(defined($order->customer->taxincluded_checked)
1512 ? $order->customer->taxincluded_checked
1513 : $::myconfig{taxincluded_checked});
1518 # recalculate prices and taxes
1520 # Using the PriceTaxCalculator. Store linetotals in the item objects.
1524 $self->order->currency_id($::instance_conf->get_currency_id()) unless $self->order->currency_id;
1526 my %pat = $self->order->calculate_prices_and_taxes();
1528 $self->{taxes} = [];
1529 foreach my $tax_id (keys %{ $pat{taxes_by_tax_id} }) {
1530 my $netamount = sum0 map { $pat{amounts}->{$_}->{amount} } grep { $pat{amounts}->{$_}->{tax_id} == $tax_id } keys %{ $pat{amounts} };
1532 push(@{ $self->{taxes} }, { amount => $pat{taxes_by_tax_id}->{$tax_id},
1533 netamount => $netamount,
1534 tax => SL::DB::Tax->new(id => $tax_id)->load });
1536 pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items_sorted}, @{$pat{items}};
1539 # get data for saving, printing, ..., that is not changed in the form
1541 # Only cvars for now.
1542 sub get_unalterable_data {
1545 foreach my $item (@{ $self->order->items }) {
1546 # autovivify all cvars that are not in the form (cvars_by_config can do it).
1547 # workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
1548 foreach my $var (@{ $item->cvars_by_config }) {
1549 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
1551 $item->parse_custom_variable_values;
1557 # And remove related files in the spool directory
1562 my $db = $self->order->db;
1564 $db->with_transaction(
1566 my @spoolfiles = grep { $_ } map { $_->spoolfile } @{ SL::DB::Manager::Status->get_all(where => [ trans_id => $self->order->id ]) };
1567 $self->order->delete;
1568 my $spool = $::lx_office_conf{paths}->{spool};
1569 unlink map { "$spool/$_" } @spoolfiles if $spool;
1572 }) || push(@{$errors}, $db->error);
1579 # And delete items that are deleted in the form.
1584 my $db = $self->order->db;
1586 $db->with_transaction(sub {
1587 SL::DB::OrderItem->new(id => $_)->delete for @{$self->item_ids_to_delete || []};
1588 $self->order->save(cascade => 1);
1591 if ($::form->{converted_from_oe_id}) {
1592 my @converted_from_oe_ids = split ' ', $::form->{converted_from_oe_id};
1593 foreach my $converted_from_oe_id (@converted_from_oe_ids) {
1594 my $src = SL::DB::Order->new(id => $converted_from_oe_id)->load;
1595 $src->update_attributes(closed => 1) if $src->type =~ /_quotation$/;
1596 $src->link_to_record($self->order);
1598 if (scalar @{ $::form->{converted_from_orderitems_ids} || [] }) {
1600 foreach (@{ $self->order->items_sorted }) {
1601 my $from_id = $::form->{converted_from_orderitems_ids}->[$idx];
1603 SL::DB::RecordLink->new(from_table => 'orderitems',
1604 from_id => $from_id,
1605 to_table => 'orderitems',
1613 }) || push(@{$errors}, $db->error);
1618 sub workflow_sales_or_purchase_order {
1622 my $errors = $self->save();
1624 if (scalar @{ $errors }) {
1625 $self->js->flash('error', $_) foreach @{ $errors };
1626 return $self->js->render();
1629 my $destination_type = $::form->{type} eq sales_quotation_type() ? sales_order_type()
1630 : $::form->{type} eq request_quotation_type() ? purchase_order_type()
1631 : $::form->{type} eq purchase_order_type() ? sales_order_type()
1632 : $::form->{type} eq sales_order_type() ? purchase_order_type()
1635 $self->order(SL::DB::Order->new_from($self->order, destination_type => $destination_type));
1636 $self->{converted_from_oe_id} = delete $::form->{id};
1638 # set item ids to new fake id, to identify them as new items
1639 foreach my $item (@{$self->order->items_sorted}) {
1640 $item->{new_fake_id} = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
1644 $::form->{type} = $destination_type;
1645 $self->type($self->init_type);
1646 $self->cv ($self->init_cv);
1650 $self->get_unalterable_data();
1651 $self->pre_render();
1653 # trigger rendering values for second row/longdescription as hidden,
1654 # because they are loaded only on demand. So we need to keep the values
1656 $_->{render_second_row} = 1 for @{ $self->order->items_sorted };
1657 $_->{render_longdescription} = 1 for @{ $self->order->items_sorted };
1661 title => $self->get_title_for('edit'),
1662 %{$self->{template_args}}
1670 $self->{all_taxzones} = SL::DB::Manager::TaxZone->get_all_sorted();
1671 $self->{all_currencies} = SL::DB::Manager::Currency->get_all_sorted();
1672 $self->{all_departments} = SL::DB::Manager::Department->get_all_sorted();
1673 $self->{all_employees} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->employee_id,
1676 $self->{all_salesmen} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->salesman_id,
1679 $self->{all_payment_terms} = SL::DB::Manager::PaymentTerm->get_all_sorted(where => [ or => [ id => $self->order->payment_id,
1681 $self->{all_delivery_terms} = SL::DB::Manager::DeliveryTerm->get_all_sorted();
1682 $self->{current_employee_id} = SL::DB::Manager::Employee->current->id;
1683 $self->{periodic_invoices_status} = $self->get_periodic_invoices_status($self->order->periodic_invoices_config);
1684 $self->{order_probabilities} = [ map { { title => ($_ * 10) . '%', id => $_ * 10 } } (0..10) ];
1685 $self->{positions_scrollbar_height} = SL::Helper::UserPreferences::PositionsScrollbar->new()->get_height();
1687 my $print_form = Form->new('');
1688 $print_form->{type} = $self->type;
1689 $print_form->{printers} = SL::DB::Manager::Printer->get_all_sorted;
1690 $print_form->{languages} = SL::DB::Manager::Language->get_all_sorted;
1691 $print_form->{language_id} = $self->order->language_id;
1692 $self->{print_options} = SL::Helper::PrintOptions->get_print_options(
1693 form => $print_form,
1694 options => {dialog_name_prefix => 'print_options.',
1698 no_opendocument => 0,
1702 foreach my $item (@{$self->order->orderitems}) {
1703 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
1704 $item->active_price_source( $price_source->price_from_source( $item->active_price_source ));
1705 $item->active_discount_source($price_source->discount_from_source($item->active_discount_source));
1708 if (any { $self->type eq $_ } (sales_order_type(), purchase_order_type())) {
1709 # calculate shipped qtys here to prevent calling calculate for every item via the items method
1710 SL::Helper::ShippedQty->new->calculate($self->order)->write_to_objects;
1713 if ($self->order->number && $::instance_conf->get_webdav) {
1714 my $webdav = SL::Webdav->new(
1715 type => $self->type,
1716 number => $self->order->number,
1718 my @all_objects = $webdav->get_all_objects;
1719 @{ $self->{template_args}->{WEBDAV} } = map { { name => $_->filename,
1721 link => File::Spec->catfile($_->full_filedescriptor),
1725 $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
1727 $::request->{layout}->use_javascript("${_}.js") for qw(kivi.SalesPurchase kivi.Order kivi.File ckeditor/ckeditor ckeditor/adapters/jquery edit_periodic_invoices_config calculate_qty);
1728 $self->setup_edit_action_bar;
1731 sub setup_edit_action_bar {
1732 my ($self, %params) = @_;
1734 my $deletion_allowed = (any { $self->type eq $_ } (sales_quotation_type(), request_quotation_type()))
1735 || (($self->type eq sales_order_type()) && $::instance_conf->get_sales_order_show_delete)
1736 || (($self->type eq purchase_order_type()) && $::instance_conf->get_purchase_order_show_delete);
1738 for my $bar ($::request->layout->get('actionbar')) {
1743 call => [ 'kivi.Order.save', 'save', $::instance_conf->get_order_warn_duplicate_parts,
1744 $::instance_conf->get_order_warn_no_deliverydate,
1746 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1750 call => [ 'kivi.Order.save', 'save_as_new', $::instance_conf->get_order_warn_duplicate_parts ],
1751 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1752 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1754 ], # end of combobox "Save"
1761 t8('Save and Sales Order'),
1762 submit => [ '#order_form', { action => "Order/sales_order" } ],
1763 only_if => (any { $self->type eq $_ } (sales_quotation_type(), purchase_order_type())),
1764 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1767 t8('Save and Purchase Order'),
1768 submit => [ '#order_form', { action => "Order/purchase_order" } ],
1769 only_if => (any { $self->type eq $_ } (sales_order_type(), request_quotation_type())),
1770 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1773 t8('Save and Delivery Order'),
1774 call => [ 'kivi.Order.save', 'save_and_delivery_order', $::instance_conf->get_order_warn_duplicate_parts,
1775 $::instance_conf->get_order_warn_no_deliverydate,
1777 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1778 only_if => (any { $self->type eq $_ } (sales_order_type(), purchase_order_type()))
1781 t8('Save and Invoice'),
1782 call => [ 'kivi.Order.save', 'save_and_invoice', $::instance_conf->get_order_warn_duplicate_parts ],
1783 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1786 t8('Save and AP Transaction'),
1787 call => [ 'kivi.Order.save', 'save_and_ap_transaction', $::instance_conf->get_order_warn_duplicate_parts ],
1788 only_if => (any { $self->type eq $_ } (purchase_order_type()))
1791 ], # end of combobox "Workflow"
1798 t8('Save and print'),
1799 call => [ 'kivi.Order.show_print_options', $::instance_conf->get_order_warn_duplicate_parts ],
1802 t8('Save and E-mail'),
1803 call => [ 'kivi.Order.email', $::instance_conf->get_order_warn_duplicate_parts ],
1806 t8('Download attachments of all parts'),
1807 call => [ 'kivi.File.downloadOrderitemsFiles', $::form->{type}, $::form->{id} ],
1808 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1809 only_if => $::instance_conf->get_doc_storage,
1811 ], # end of combobox "Export"
1815 call => [ 'kivi.Order.delete_order' ],
1816 confirm => $::locale->text('Do you really want to delete this object?'),
1817 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1818 only_if => $deletion_allowed,
1825 my ($order, $pdf_ref, $params) = @_;
1829 my $print_form = Form->new('');
1830 $print_form->{type} = $order->type;
1831 $print_form->{formname} = $params->{formname} || $order->type;
1832 $print_form->{format} = $params->{format} || 'pdf';
1833 $print_form->{media} = $params->{media} || 'file';
1834 $print_form->{groupitems} = $params->{groupitems};
1835 $print_form->{media} = 'file' if $print_form->{media} eq 'screen';
1837 $order->language($params->{language});
1838 $order->flatten_to_form($print_form, format_amounts => 1);
1842 if ($print_form->{format} =~ /(opendocument|oasis)/i) {
1843 $template_ext = 'odt';
1844 $template_type = 'OpenDocument';
1847 # search for the template
1848 my ($template_file, @template_files) = SL::Helper::CreatePDF->find_template(
1849 name => $print_form->{formname},
1850 extension => $template_ext,
1851 email => $print_form->{media} eq 'email',
1852 language => $params->{language},
1853 printer_id => $print_form->{printer_id}, # todo
1856 if (!defined $template_file) {
1857 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);
1860 return @errors if scalar @errors;
1862 $print_form->throw_on_error(sub {
1864 $print_form->prepare_for_printing;
1866 $$pdf_ref = SL::Helper::CreatePDF->create_pdf(
1867 format => $print_form->{format},
1868 template_type => $template_type,
1869 template => $template_file,
1870 variables => $print_form,
1871 variable_content_types => {
1872 longdescription => 'html',
1873 partnotes => 'html',
1878 } || push @errors, ref($EVAL_ERROR) eq 'SL::X::FormError' ? $EVAL_ERROR->error : $EVAL_ERROR;
1884 sub get_files_for_email_dialog {
1887 my %files = map { ($_ => []) } qw(versions files vc_files part_files);
1889 return %files if !$::instance_conf->get_doc_storage;
1891 if ($self->order->id) {
1892 $files{versions} = [ SL::File->get_all_versions(object_id => $self->order->id, object_type => $self->order->type, file_type => 'document') ];
1893 $files{files} = [ SL::File->get_all( object_id => $self->order->id, object_type => $self->order->type, file_type => 'attachment') ];
1894 $files{vc_files} = [ SL::File->get_all( object_id => $self->order->{$self->cv}->id, object_type => $self->cv, file_type => 'attachment') ];
1898 uniq_by { $_->{id} }
1900 +{ id => $_->part->id,
1901 partnumber => $_->part->partnumber }
1902 } @{$self->order->items_sorted};
1904 foreach my $part (@parts) {
1905 my @pfiles = SL::File->get_all(object_id => $part->{id}, object_type => 'part');
1906 push @{ $files{part_files} }, map { +{ %{ $_ }, partnumber => $part->{partnumber} } } @pfiles;
1909 foreach my $key (keys %files) {
1910 $files{$key} = [ sort_by { lc $_->{db_file}->{file_name} } @{ $files{$key} } ];
1916 sub make_periodic_invoices_config_from_yaml {
1917 my ($yaml_config) = @_;
1919 return if !$yaml_config;
1920 my $attr = SL::YAML::Load($yaml_config);
1921 return if 'HASH' ne ref $attr;
1922 return SL::DB::PeriodicInvoicesConfig->new(%$attr);
1926 sub get_periodic_invoices_status {
1927 my ($self, $config) = @_;
1929 return if $self->type ne sales_order_type();
1930 return t8('not configured') if !$config;
1932 my $active = ('HASH' eq ref $config) ? $config->{active}
1933 : ('SL::DB::PeriodicInvoicesConfig' eq ref $config) ? $config->active
1934 : die "Cannot get status of periodic invoices config";
1936 return $active ? t8('active') : t8('inactive');
1940 my ($self, $action) = @_;
1942 return '' if none { lc($action)} qw(add edit);
1945 # $::locale->text("Add Sales Order");
1946 # $::locale->text("Add Purchase Order");
1947 # $::locale->text("Add Quotation");
1948 # $::locale->text("Add Request for Quotation");
1949 # $::locale->text("Edit Sales Order");
1950 # $::locale->text("Edit Purchase Order");
1951 # $::locale->text("Edit Quotation");
1952 # $::locale->text("Edit Request for Quotation");
1954 $action = ucfirst(lc($action));
1955 return $self->type eq sales_order_type() ? $::locale->text("$action Sales Order")
1956 : $self->type eq purchase_order_type() ? $::locale->text("$action Purchase Order")
1957 : $self->type eq sales_quotation_type() ? $::locale->text("$action Quotation")
1958 : $self->type eq request_quotation_type() ? $::locale->text("$action Request for Quotation")
1962 sub get_item_cvpartnumber {
1963 my ($self, $item) = @_;
1965 return if !$self->search_cvpartnumber;
1966 return if !$self->order->customervendor;
1968 if ($self->cv eq 'vendor') {
1969 my @mms = grep { $_->make eq $self->order->customervendor->id } @{$item->part->makemodels};
1970 $item->{cvpartnumber} = $mms[0]->model if scalar @mms;
1971 } elsif ($self->cv eq 'customer') {
1972 my @cps = grep { $_->customer_id eq $self->order->customervendor->id } @{$item->part->customerprices};
1973 $item->{cvpartnumber} = $cps[0]->customer_partnumber if scalar @cps;
1977 sub sales_order_type {
1981 sub purchase_order_type {
1985 sub sales_quotation_type {
1989 sub request_quotation_type {
1990 'request_quotation';
1994 return $_[0]->type eq sales_order_type() ? 'ordnumber'
1995 : $_[0]->type eq purchase_order_type() ? 'ordnumber'
1996 : $_[0]->type eq sales_quotation_type() ? 'quonumber'
1997 : $_[0]->type eq request_quotation_type() ? 'quonumber'
2009 SL::Controller::Order - controller for orders
2013 This is a new form to enter orders, completely rewritten with the use
2014 of controller and java script techniques.
2016 The aim is to provide the user a better experience and a faster workflow. Also
2017 the code should be more readable, more reliable and better to maintain.
2025 One input row, so that input happens every time at the same place.
2029 Use of pickers where possible.
2033 Possibility to enter more than one item at once.
2037 Item list in a scrollable area, so that the workflow buttons stay at
2042 Reordering item rows with drag and drop is possible. Sorting item rows is
2043 possible (by partnumber, description, qty, sellprice and discount for now).
2047 No C<update> is necessary. All entries and calculations are managed
2048 with ajax-calls and the page only reloads on C<save>.
2052 User can see changes immediately, because of the use of java script
2063 =item * C<SL/Controller/Order.pm>
2067 =item * C<template/webpages/order/form.html>
2071 =item * C<template/webpages/order/tabs/basic_data.html>
2073 Main tab for basic_data.
2075 This is the only tab here for now. "linked records" and "webdav" tabs are
2076 reused from generic code.
2080 =item * C<template/webpages/order/tabs/_business_info_row.html>
2082 For displaying information on business type
2084 =item * C<template/webpages/order/tabs/_item_input.html>
2086 The input line for items
2088 =item * C<template/webpages/order/tabs/_row.html>
2090 One row for already entered items
2092 =item * C<template/webpages/order/tabs/_tax_row.html>
2094 Displaying tax information
2096 =item * C<template/webpages/order/tabs/_multi_items_dialog.html>
2098 Dialog for entering more than one item at once
2100 =item * C<template/webpages/order/tabs/_multi_items_result.html>
2102 Results for the filter in the multi items dialog
2104 =item * C<template/webpages/order/tabs/_price_sources_dialog.html>
2106 Dialog for selecting price and discount sources
2110 =item * C<js/kivi.Order.js>
2112 java script functions
2124 =item * credit limit
2126 =item * more workflows (quotation, rfq)
2128 =item * price sources: little symbols showing better price / better discount
2130 =item * select units in input row?
2132 =item * custom shipto address
2134 =item * check for direct delivery (workflow sales order -> purchase order)
2136 =item * language / part translations
2138 =item * access rights
2140 =item * display weights
2146 =item * optional client/user behaviour
2148 (transactions has to be set - department has to be set -
2149 force project if enabled in client config - transport cost reminder)
2153 =head1 KNOWN BUGS AND CAVEATS
2159 Customer discount is not displayed as a valid discount in price source popup
2160 (this might be a bug in price sources)
2162 (I cannot reproduce this (Bernd))
2166 No indication that <shift>-up/down expands/collapses second row.
2170 Inline creation of parts is not currently supported
2174 Table header is not sticky in the scrolling area.
2178 Sorting does not include C<position>, neither does reordering.
2180 This behavior was implemented intentionally. But we can discuss, which behavior
2181 should be implemented.
2185 C<show_multi_items_dialog> does not use the currently inserted string for
2190 =head1 To discuss / Nice to have
2196 How to expand/collapse second row. Now it can be done clicking the icon or
2201 Possibility to change longdescription in input row?
2205 Possibility to select PriceSources in input row?
2209 This controller uses a (changed) copy of the template for the PriceSource
2210 dialog. Maybe there could be used one code source.
2214 Rounding-differences between this controller (PriceTaxCalculator) and the old
2215 form. This is not only a problem here, but also in all parts using the PTC.
2216 There exists a ticket and a patch. This patch should be testet.
2220 An indicator, if the actual inputs are saved (like in an
2221 editor or on text processing application).
2225 A warning when leaving the page without saveing unchanged inputs.
2232 Bernd Bleßmann E<lt>bernd@kivitendo-premium.deE<gt>