1 package SL::Controller::Order;
4 use parent qw(SL::Controller::Base);
8 use SL::Locale::String;
9 use SL::SessionFile::Random;
25 use SL::Helper::DateTime;
26 use SL::Helper::CreatePDF qw(:all);
28 use SL::Controller::Helper::GetModels;
30 use List::Util qw(max first);
31 use List::MoreUtils qw(none pairwise first_index);
32 use English qw(-no_match_vars);
35 use Rose::Object::MakeMethods::Generic
37 'scalar --get_set_init' => [ qw(order valid_types type cv p multi_items_models) ],
42 __PACKAGE__->run_before('_check_auth');
44 __PACKAGE__->run_before('_recalc',
45 only => [ qw(edit update save save_and_delivery_order create_pdf send_email) ]);
47 __PACKAGE__->run_before('_get_unalterable_data',
48 only => [ qw(save save_and_delivery_order create_pdf send_email) ]);
57 $self->order->transdate(DateTime->now_local());
58 $self->order->reqdate(DateTime->today_local->next_workday) if !$self->order->reqdate;
63 title => $self->type eq _sales_order_type() ? $::locale->text('Add Sales Order')
64 : $self->type eq _purchase_order_type() ? $::locale->text('Add Purchase Order')
66 %{$self->{template_args}}
76 title => $self->type eq _sales_order_type() ? $::locale->text('Edit Sales Order')
77 : $self->type eq _purchase_order_type() ? $::locale->text('Edit Purchase Order')
79 %{$self->{template_args}}
89 title => $self->type eq _sales_order_type() ? $::locale->text('Edit Sales Order')
90 : $self->type eq _purchase_order_type() ? $::locale->text('Edit Purchase Order')
92 %{$self->{template_args}}
99 my $errors = $self->_delete();
101 if (scalar @{ $errors }) {
102 $self->js->flash('error', $_) foreach @{ $errors };
103 return $self->js->render();
106 flash_later('info', $::locale->text('The order has been deleted'));
107 my @redirect_params = (
112 $self->redirect_to(@redirect_params);
118 my $errors = $self->_save();
120 if (scalar @{ $errors }) {
121 $self->js->flash('error', $_) foreach @{ $errors };
122 return $self->js->render();
125 flash_later('info', $::locale->text('The order has been saved'));
126 my @redirect_params = (
129 id => $self->order->id,
132 $self->redirect_to(@redirect_params);
135 sub action_create_pdf {
139 my @errors = _create_pdf($self->order, \$pdf);
140 if (scalar @errors) {
141 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
144 my $sfile = SL::SessionFile::Random->new(mode => "w");
145 $sfile->fh->print($pdf);
148 my $key = join('_', Time::HiRes::gettimeofday(), int rand 1000000000000);
149 $::auth->set_session_value("Order::create_pdf-${key}" => $sfile->file_name);
151 my $form = Form->new;
152 $form->{ordnumber} = $self->order->ordnumber;
153 $form->{formname} = $self->type;
154 $form->{type} = $self->type;
155 $form->{language} = 'de';
156 $form->{format} = 'pdf';
158 my $pdf_filename = $form->generate_attachment_filename();
160 # copy file to webdav folder
161 if ($self->order->ordnumber && $::instance_conf->get_webdav_documents) {
162 my $webdav = SL::Webdav->new(
164 number => $self->order->ordnumber,
166 my $webdav_file = SL::Webdav::File->new(
168 filename => $pdf_filename,
171 $webdav_file->store(data => \$pdf);
174 $self->js->flash('error', t8('Storing PDF to webdav folder failed: #1', $@));
179 ->run('download_pdf', $pdf_filename, $key)
180 ->flash('info', t8('The PDF has been created'))->render($self);
183 sub action_download_pdf {
186 my $key = $::form->{key};
187 my $tmp_filename = $::auth->get_session_value("Order::create_pdf-${key}");
188 return $self->send_file(
190 type => 'application/pdf',
191 name => $::form->{pdf_filename},
195 sub action_show_email_dialog {
198 my $cv_method = $self->cv;
200 if (!$self->order->$cv_method) {
201 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'))
205 $self->{email}->{to} = $self->order->contact->cp_email if $self->order->contact;
206 $self->{email}->{to} ||= $self->order->$cv_method->email;
207 $self->{email}->{cc} = $self->order->$cv_method->cc;
208 $self->{email}->{bcc} = join ', ', grep $_, $self->order->$cv_method->bcc, SL::DB::Default->get->global_bcc;
209 # Todo: get addresses from shipto, if any
211 my $form = Form->new;
212 $form->{ordnumber} = $self->order->ordnumber;
213 $form->{formname} = $self->type;
214 $form->{type} = $self->type;
215 $form->{language} = 'de';
216 $form->{format} = 'pdf';
218 $self->{email}->{subject} = $form->generate_email_subject();
219 $self->{email}->{attachment_filename} = $form->generate_attachment_filename();
220 $self->{email}->{message} = $form->create_email_signature();
222 my $dialog_html = $self->render('order/tabs/_email_dialog', { output => 0 });
224 ->run('show_email_dialog', $dialog_html)
229 # Todo: handling error messages: flash is not displayed in dialog, but in the main form
230 sub action_send_email {
233 my $mail = Mailer->new;
234 $mail->{from} = qq|"$::myconfig{name}" <$::myconfig{email}>|;
235 $mail->{$_} = $::form->{email}->{$_} for qw(to cc bcc subject message);
238 my @errors = _create_pdf($self->order, \$pdf, {media => 'email'});
239 if (scalar @errors) {
240 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
243 $mail->{attachments} = [{ "content" => $pdf,
244 "name" => $::form->{email}->{attachment_filename} }];
246 if (my $err = $mail->send) {
247 return $self->js->flash('error', t8('Sending E-mail: ') . $err)
252 my $intnotes = $self->order->intnotes;
253 $intnotes .= "\n\n" if $self->order->intnotes;
254 $intnotes .= t8('[email]') . "\n";
255 $intnotes .= t8('Date') . ": " . $::locale->format_date_object(DateTime->now_local, precision => 'seconds') . "\n";
256 $intnotes .= t8('To (email)') . ": " . $mail->{to} . "\n";
257 $intnotes .= t8('Cc') . ": " . $mail->{cc} . "\n" if $mail->{cc};
258 $intnotes .= t8('Bcc') . ": " . $mail->{bcc} . "\n" if $mail->{bcc};
259 $intnotes .= t8('Subject') . ": " . $mail->{subject} . "\n\n";
260 $intnotes .= t8('Message') . ": " . $mail->{message};
263 ->val('#order_intnotes', $intnotes)
264 ->run('close_email_dialog')
268 sub action_save_and_delivery_order {
271 my $errors = $self->_save();
273 if (scalar @{ $errors }) {
274 $self->js->flash('error', $_) foreach @{ $errors };
275 return $self->js->render();
277 flash_later('info', $::locale->text('The order has been saved'));
279 my @redirect_params = (
280 controller => 'oe.pl',
281 action => 'oe_delivery_order_from_order',
282 id => $self->order->id,
285 $self->redirect_to(@redirect_params);
288 sub action_customer_vendor_changed {
291 my $cv_method = $self->cv;
293 if ($self->order->$cv_method->contacts && scalar @{ $self->order->$cv_method->contacts } > 0) {
294 $self->js->show('#cp_row');
296 $self->js->hide('#cp_row');
299 if ($self->order->$cv_method->shipto && scalar @{ $self->order->$cv_method->shipto } > 0) {
300 $self->js->show('#shipto_row');
302 $self->js->hide('#shipto_row');
305 $self->order->taxzone_id($self->order->$cv_method->taxzone_id);
307 if ($self->order->is_sales) {
308 $self->order->taxincluded(defined($self->order->$cv_method->taxincluded_checked)
309 ? $self->order->$cv_method->taxincluded_checked
310 : $::myconfig{taxincluded_checked});
313 $self->order->payment_id($self->order->$cv_method->payment_id);
314 $self->order->delivery_term_id($self->order->$cv_method->delivery_term_id);
319 ->replaceWith('#order_cp_id', $self->build_contact_select)
320 ->replaceWith('#order_shipto_id', $self->build_shipto_select)
321 ->val( '#order_taxzone_id', $self->order->taxzone_id)
322 ->val( '#order_taxincluded', $self->order->taxincluded)
323 ->val( '#order_payment_id', $self->order->payment_id)
324 ->val( '#order_delivery_term_id', $self->order->delivery_term_id)
325 ->val( '#order_intnotes', $self->order->$cv_method->notes)
326 ->focus( '#order_' . $self->cv . '_id');
328 $self->_js_redisplay_amounts_and_taxes;
332 sub action_unit_changed {
335 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
336 my $item = $self->order->items->[$idx];
338 my $old_unit_obj = SL::DB::Unit->new(name => $::form->{old_unit})->load;
339 $item->sellprice($item->unit_obj->convert_to($item->sellprice, $old_unit_obj));
344 ->run('update_sellprice', $::form->{item_id}, $item->sellprice_as_number);
345 $self->_js_redisplay_linetotals;
346 $self->_js_redisplay_amounts_and_taxes;
350 sub action_add_item {
353 my $form_attr = $::form->{add_item};
355 return unless $form_attr->{parts_id};
357 my $item = _make_item($self->order, $form_attr);
358 $self->order->add_items($item);
362 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
363 my $row_as_html = $self->p->render('order/tabs/_row', ITEM => $item, ID => $item_id);
366 ->append('#row_table_id', $row_as_html)
367 ->val('.add_item_input', '')
368 ->run('row_table_scroll_down')
369 ->run('row_set_keyboard_events_by_id', $item_id)
370 ->run('set_unit_change_with_oldval_by_id', $item_id)
371 ->on('.recalc', 'change', 'recalc_amounts_and_taxes')
372 ->on('.reformat_number', 'change', 'reformat_number')
373 ->focus('#add_item_parts_id_name');
375 $self->_js_redisplay_amounts_and_taxes;
379 sub action_show_multi_items_dialog {
380 require SL::DB::PartsGroup;
381 $_[0]->render('order/tabs/_multi_items_dialog', { layout => 0 },
382 all_partsgroups => SL::DB::Manager::PartsGroup->get_all);
385 sub action_multi_items_update_result {
387 my $count = $_[0]->multi_items_models->count;
390 my $text = SL::Presenter::EscapedText->new(text => $::locale->text('No results.'));
391 $_[0]->render($text, { layout => 0 });
392 } elsif ($count > $max_count) {
393 my $text = SL::Presenter::EscapedText->new(text => $::locale->text('Too many results (#1 from #2).', $count, $max_count));
394 $_[0]->render($text, { layout => 0 });
396 my $multi_items = $_[0]->multi_items_models->get;
397 $_[0]->render('order/tabs/_multi_items_result', { layout => 0 },
398 multi_items => $multi_items);
402 sub action_add_multi_items {
405 my @form_attr = grep { $_->{qty_as_number} } @{ $::form->{add_multi_items} };
406 return $self->js->render() unless scalar @form_attr;
409 foreach my $attr (@form_attr) {
410 push @items, _make_item($self->order, $attr);
412 $self->order->add_items(@items);
416 foreach my $item (@items) {
417 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
418 my $row_as_html = $self->p->render('order/tabs/_row', ITEM => $item, ID => $item_id);
421 ->append('#row_table_id', $row_as_html)
422 ->run('row_set_keyboard_events_by_id', $item_id)
423 ->run('set_unit_change_with_oldval_by_id', $item_id);
427 ->run('close_multi_items_dialog')
428 ->run('row_table_scroll_down')
429 ->on('.recalc', 'change', 'recalc_amounts_and_taxes')
430 ->on('.reformat_number', 'change', 'reformat_number')
431 ->focus('#add_item_parts_id_name');
433 $self->_js_redisplay_amounts_and_taxes;
437 sub action_recalc_amounts_and_taxes {
442 $self->_js_redisplay_linetotals;
443 $self->_js_redisplay_amounts_and_taxes;
447 sub action_price_popup {
450 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
451 my $item = $self->order->items->[$idx];
453 $self->render_price_dialog($item);
456 sub _js_redisplay_linetotals {
459 my @data = map {$::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0)} @{ $self->order->items };
461 ->run('redisplay_linetotals', \@data);
464 sub _js_redisplay_amounts_and_taxes {
467 if (scalar @{ $self->{taxes} }) {
468 $self->js->show('#taxincluded_row_id');
470 $self->js->hide('#taxincluded_row_id');
473 if ($self->order->taxincluded) {
474 $self->js->hide('#subtotal_row_id');
476 $self->js->show('#subtotal_row_id');
480 ->html('#netamount_id', $::form->format_amount(\%::myconfig, $self->order->netamount, -2))
481 ->html('#amount_id', $::form->format_amount(\%::myconfig, $self->order->amount, -2))
483 ->insertBefore($self->build_tax_rows, '#amount_row_id');
490 sub init_valid_types {
491 [ _sales_order_type(), _purchase_order_type() ];
497 if (none { $::form->{type} eq $_ } @{$self->valid_types}) {
498 die "Not a valid type for order";
501 $self->type($::form->{type});
507 my $cv = $self->type eq _sales_order_type() ? 'customer'
508 : $self->type eq _purchase_order_type() ? 'vendor'
509 : die "Not a valid type for order";
522 sub init_multi_items_models {
523 SL::Controller::Helper::GetModels->new(
526 with_objects => [ qw(unit_obj) ],
527 disable_plugin => 'paginated',
528 source => $::form->{multi_items},
534 partnumber => t8('Partnumber'),
535 description => t8('Description')}
542 my $right_for = { map { $_ => $_.'_edit' } @{$self->valid_types} };
544 my $right = $right_for->{ $self->type };
545 $right ||= 'DOES_NOT_EXIST';
547 $::auth->assert($right);
550 sub build_contact_select {
553 $self->p->select_tag('order.cp_id', [ $self->order->{$self->cv}->contacts ],
554 value_key => 'cp_id',
555 title_key => 'full_name_dep',
556 default => $self->order->cp_id,
558 style => 'width: 300px',
562 sub build_shipto_select {
565 $self->p->select_tag('order.shipto_id', [ $self->order->{$self->cv}->shipto ],
566 value_key => 'shipto_id',
567 title_key => 'displayable_id',
568 default => $self->order->shipto_id,
570 style => 'width: 300px',
578 foreach my $tax (sort { $a->{tax}->rate cmp $b->{tax}->rate } @{ $self->{taxes} }) {
579 $rows_as_html .= $self->p->render('order/tabs/_tax_row', TAX => $tax, TAXINCLUDED => $self->order->taxincluded);
581 return $rows_as_html;
585 sub render_price_dialog {
586 my ($self, $record_item) = @_;
588 my $price_source = SL::PriceSource->new(record_item => $record_item, record => $self->order);
592 'kivi.io.price_chooser_dialog',
593 t8('Available Prices'),
594 $self->render('order/tabs/_price_sources_dialog', { output => 0 }, price_source => $price_source)
599 # $self->js->text('#dialog_flash_error_content', join ' ', @errors);
600 # $self->js->show('#dialog_flash_error');
609 # add_items adds items to an order with no items for saving, but they cannot
610 # be retrieved via items until the order is saved. Adding empty items to new
611 # order here solves this problem.
613 $order = SL::DB::Manager::Order->find_by(id => $::form->{id}) if $::form->{id};
614 $order ||= SL::DB::Order->new(orderitems => []);
616 $order->assign_attributes(%{$::form->{order}});
622 my ($record, $attr) = @_;
624 my $item = SL::DB::OrderItem->new;
625 $item->assign_attributes(%$attr);
627 my $part = SL::DB::Part->new(id => $attr->{parts_id})->load;
628 my $price_source = SL::PriceSource->new(record_item => $item, record => $record);
630 $item->unit($part->unit) if !$item->unit;
633 if ($item->sellprice) {
634 $price_src = $price_source->price_from_source("");
635 $price_src->price($item->sellprice);
637 $price_src = $price_source->best_price
638 ? $price_source->best_price
639 : $price_source->price_from_source("");
640 $price_src->price(0) if !$price_source->best_price;
644 if ($item->discount) {
645 $discount_src = $price_source->discount_from_source("");
646 $discount_src->discount($item->discount);
648 $discount_src = $price_source->best_discount
649 ? $price_source->best_discount
650 : $price_source->discount_from_source("");
651 $discount_src->discount(0) if !$price_source->best_discount;
655 $new_attr{part} = $part;
656 $new_attr{description} = $part->description if ! $item->description;
657 $new_attr{qty} = 1.0 if ! $item->qty;
658 $new_attr{sellprice} = $price_src->price;
659 $new_attr{discount} = $discount_src->discount;
660 $new_attr{active_price_source} = $price_src;
661 $new_attr{active_discount_source} = $discount_src;
663 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
664 # they cannot be retrieved via custom_variables until the order/orderitem is
665 # saved. Adding empty custom_variables to new orderitem here solves this problem.
666 $new_attr{custom_variables} = [];
668 $item->assign_attributes(%new_attr);
676 # bb: todo: currency later
677 $self->order->currency_id($::instance_conf->get_currency_id());
679 my %pat = $self->order->calculate_prices_and_taxes();
681 foreach my $tax_chart_id (keys %{ $pat{taxes} }) {
682 my $tax = SL::DB::Manager::Tax->find_by(chart_id => $tax_chart_id);
684 my @amount_keys = grep { $pat{amounts}->{$_}->{tax_id} == $tax->id } keys %{ $pat{amounts} };
685 push(@{ $self->{taxes} }, { amount => $pat{taxes}->{$tax_chart_id},
686 netamount => $pat{amounts}->{$amount_keys[0]}->{amount},
690 pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items}, @{$pat{items}};
694 sub _get_unalterable_data {
697 foreach my $item (@{ $self->order->items }) {
699 # load data from orderitems (db)
700 my $db_item = SL::DB::OrderItem->new(id => $item->id)->load;
701 $item->$_($db_item->$_) for qw(longdescription);
703 # set data from part (or other sources)
704 $item->longdescription($item->part->notes);
707 # autovivify all cvars that are not in the form (cvars_by_config can do it).
708 # workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
709 foreach my $var (@{ $item->cvars_by_config }) {
710 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
712 $item->parse_custom_variable_values;
721 my $db = $self->order->db;
725 my @spoolfiles = grep { $_ } map { $_->spoolfile } @{ SL::DB::Manager::Status->get_all(where => [ trans_id => $self->order->id ]) };
726 $self->order->delete;
727 my $spool = $::lx_office_conf{paths}->{spool};
728 unlink map { "$spool/$_" } @spoolfiles if $spool;
731 }) || push(@{$errors}, $db->error);
741 my $db = $self->order->db;
745 $self->order->save();
746 }) || push(@{$errors}, $db->error);
755 $self->{all_taxzones} = SL::DB::Manager::TaxZone->get_all_sorted();
756 $self->{all_departments} = SL::DB::Manager::Department->get_all_sorted();
757 $self->{all_employees} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->employee_id,
760 $self->{all_salesmen} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->salesman_id,
763 $self->{all_projects} = SL::DB::Manager::Project->get_all(where => [ or => [ id => $self->order->globalproject_id,
765 sort_by => 'projectnumber');
766 $self->{all_payment_terms} = SL::DB::Manager::PaymentTerm->get_all_sorted();
767 $self->{all_delivery_terms} = SL::DB::Manager::DeliveryTerm->get_all_sorted();
769 $self->{current_employee_id} = SL::DB::Manager::Employee->current->id;
771 foreach my $item (@{$self->order->items}) {
772 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
773 $item->active_price_source( $price_source->price_from_source( $item->active_price_source ));
774 $item->active_discount_source($price_source->discount_from_source($item->active_discount_source));
778 if ($self->order->ordnumber && $::instance_conf->get_webdav) {
779 my $webdav = SL::Webdav->new(
781 number => $self->order->ordnumber,
783 my $webdav_path = $webdav->webdav_path;
784 my @all_objects = $webdav->get_all_objects;
785 @{ $self->{template_args}->{WEBDAV} } = map { { name => $_->filename,
787 link => File::Spec->catdir($webdav_path, $_->filename),
791 $::request->{layout}->use_javascript("${_}.js") for qw(ckeditor/ckeditor ckeditor/adapters/jquery);
795 my ($order, $pdf_ref, $params) = @_;
797 my $print_form = Form->new('');
798 $print_form->{type} = $order->type;
799 $print_form->{formname} = $order->type;
800 $print_form->{format} = $params->{format} || 'pdf',
801 $print_form->{media} = $params->{media} || 'file';
803 $order->flatten_to_form($print_form, format_amounts => 1);
804 # flatten_to_form sets payment_terms from customer/vendor - we do not want that here
805 delete $print_form->{payment_terms} if !$print_form->{payment_id};
808 $print_form->throw_on_error(sub {
810 $print_form->prepare_for_printing;
812 $$pdf_ref = SL::Helper::CreatePDF->create_pdf(
813 template => SL::Helper::CreatePDF->find_template(name => $print_form->{formname}),
814 variables => $print_form,
815 variable_content_types => {
816 longdescription => 'html',
822 } || push @errors, ref($EVAL_ERROR) eq 'SL::X::FormError' ? $EVAL_ERROR->getMessage : $EVAL_ERROR;
828 sub _sales_order_type {
832 sub _purchase_order_type {