1 package SL::Controller::Order;
4 use parent qw(SL::Controller::Base);
8 use SL::Locale::String;
9 use SL::SessionFile::Random;
24 use SL::Helper::DateTime;
25 use SL::Helper::CreatePDF qw(:all);
27 use List::Util qw(max first);
28 use List::MoreUtils qw(none pairwise first_index);
29 use English qw(-no_match_vars);
32 use Rose::Object::MakeMethods::Generic
34 'scalar --get_set_init' => [ qw(order valid_types type cv p) ],
39 __PACKAGE__->run_before('_check_auth');
41 __PACKAGE__->run_before('_recalc',
42 only => [ qw(edit update save save_and_delivery_order create_pdf send_email) ]);
44 __PACKAGE__->run_before('_get_unalterable_data',
45 only => [ qw(save save_and_delivery_order create_pdf send_email) ]);
54 $self->order->transdate(DateTime->now_local());
55 $self->order->reqdate(DateTime->today_local->next_workday) if !$self->order->reqdate;
60 title => $self->type eq _sales_order_type() ? $::locale->text('Add Sales Order')
61 : $self->type eq _purchase_order_type() ? $::locale->text('Add Purchase Order')
63 %{$self->{template_args}}
73 title => $self->type eq _sales_order_type() ? $::locale->text('Edit Sales Order')
74 : $self->type eq _purchase_order_type() ? $::locale->text('Edit Purchase Order')
76 %{$self->{template_args}}
86 title => $self->type eq _sales_order_type() ? $::locale->text('Edit Sales Order')
87 : $self->type eq _purchase_order_type() ? $::locale->text('Edit Purchase Order')
89 %{$self->{template_args}}
96 my $errors = $self->_delete();
98 if (scalar @{ $errors }) {
99 $self->js->flash('error', $_) foreach @{ $errors };
100 return $self->js->render();
103 flash_later('info', $::locale->text('The order has been deleted'));
104 my @redirect_params = (
109 $self->redirect_to(@redirect_params);
115 my $errors = $self->_save();
117 if (scalar @{ $errors }) {
118 $self->js->flash('error', $_) foreach @{ $errors };
119 return $self->js->render();
122 flash_later('info', $::locale->text('The order has been saved'));
123 my @redirect_params = (
126 id => $self->order->id,
129 $self->redirect_to(@redirect_params);
132 sub action_create_pdf {
136 my @errors = _create_pdf($self->order, \$pdf);
137 if (scalar @errors) {
138 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
141 my $sfile = SL::SessionFile::Random->new(mode => "w");
142 $sfile->fh->print($pdf);
145 my $key = join('_', Time::HiRes::gettimeofday(), int rand 1000000000000);
146 $::auth->set_session_value("Order::create_pdf-${key}" => $sfile->file_name);
148 my $form = Form->new;
149 $form->{ordnumber} = $self->order->ordnumber;
150 $form->{formname} = $self->type;
151 $form->{type} = $self->type;
152 $form->{language} = 'de';
153 $form->{format} = 'pdf';
155 my $pdf_filename = $form->generate_attachment_filename();
157 # copy file to webdav folder
158 if ($self->order->ordnumber && $::instance_conf->get_webdav_documents) {
159 my $webdav = SL::Webdav->new(
161 number => $self->order->ordnumber,
163 my $webdav_file = SL::Webdav::File->new(
165 filename => $pdf_filename,
168 $webdav_file->store(data => \$pdf);
171 $self->js->flash('error', t8('Storing PDF to webdav folder failed: #1', $@));
176 ->run('download_pdf', $pdf_filename, $key)
177 ->flash('info', t8('The PDF has been created'))->render($self);
180 sub action_download_pdf {
183 my $key = $::form->{key};
184 my $tmp_filename = $::auth->get_session_value("Order::create_pdf-${key}");
185 return $self->send_file(
187 type => 'application/pdf',
188 name => $::form->{pdf_filename},
192 sub action_show_email_dialog {
195 my $cv_method = $self->cv;
197 if (!$self->order->$cv_method) {
198 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'))
202 $self->{email}->{to} = $self->order->contact->cp_email if $self->order->contact;
203 $self->{email}->{to} ||= $self->order->$cv_method->email;
204 $self->{email}->{cc} = $self->order->$cv_method->cc;
205 $self->{email}->{bcc} = join ', ', grep $_, $self->order->$cv_method->bcc, SL::DB::Default->get->global_bcc;
206 # Todo: get addresses from shipto, if any
208 my $form = Form->new;
209 $form->{ordnumber} = $self->order->ordnumber;
210 $form->{formname} = $self->type;
211 $form->{type} = $self->type;
212 $form->{language} = 'de';
213 $form->{format} = 'pdf';
215 $self->{email}->{subject} = $form->generate_email_subject();
216 $self->{email}->{attachment_filename} = $form->generate_attachment_filename();
217 $self->{email}->{message} = $form->create_email_signature();
219 my $dialog_html = $self->render('order/tabs/_email_dialog', { output => 0 });
221 ->run('show_email_dialog', $dialog_html)
226 # Todo: handling error messages: flash is not displayed in dialog, but in the main form
227 sub action_send_email {
230 my $mail = Mailer->new;
231 $mail->{from} = qq|"$::myconfig{name}" <$::myconfig{email}>|;
232 $mail->{$_} = $::form->{email}->{$_} for qw(to cc bcc subject message);
235 my @errors = _create_pdf($self->order, \$pdf, {media => 'email'});
236 if (scalar @errors) {
237 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
240 $mail->{attachments} = [{ "content" => $pdf,
241 "name" => $::form->{email}->{attachment_filename} }];
243 if (my $err = $mail->send) {
244 return $self->js->flash('error', t8('Sending E-mail: ') . $err)
249 my $intnotes = $self->order->intnotes;
250 $intnotes .= "\n\n" if $self->order->intnotes;
251 $intnotes .= t8('[email]') . "\n";
252 $intnotes .= t8('Date') . ": " . $::locale->format_date_object(DateTime->now_local, precision => 'seconds') . "\n";
253 $intnotes .= t8('To (email)') . ": " . $mail->{to} . "\n";
254 $intnotes .= t8('Cc') . ": " . $mail->{cc} . "\n" if $mail->{cc};
255 $intnotes .= t8('Bcc') . ": " . $mail->{bcc} . "\n" if $mail->{bcc};
256 $intnotes .= t8('Subject') . ": " . $mail->{subject} . "\n\n";
257 $intnotes .= t8('Message') . ": " . $mail->{message};
260 ->val('#order_intnotes', $intnotes)
261 ->run('close_email_dialog')
265 sub action_save_and_delivery_order {
268 my $errors = $self->_save();
270 if (scalar @{ $errors }) {
271 $self->js->flash('error', $_) foreach @{ $errors };
272 return $self->js->render();
274 flash_later('info', $::locale->text('The order has been saved'));
276 my @redirect_params = (
277 controller => 'oe.pl',
278 action => 'oe_delivery_order_from_order',
279 id => $self->order->id,
282 $self->redirect_to(@redirect_params);
285 sub action_customer_vendor_changed {
288 my $cv_method = $self->cv;
290 if ($self->order->$cv_method->contacts && scalar @{ $self->order->$cv_method->contacts } > 0) {
291 $self->js->show('#cp_row');
293 $self->js->hide('#cp_row');
296 if ($self->order->$cv_method->shipto && scalar @{ $self->order->$cv_method->shipto } > 0) {
297 $self->js->show('#shipto_row');
299 $self->js->hide('#shipto_row');
302 $self->order->taxzone_id($self->order->$cv_method->taxzone_id);
304 if ($self->order->is_sales) {
305 $self->order->taxincluded(defined($self->order->$cv_method->taxincluded_checked)
306 ? $self->order->$cv_method->taxincluded_checked
307 : $::myconfig{taxincluded_checked});
310 $self->order->payment_id($self->order->$cv_method->payment_id);
311 $self->order->delivery_term_id($self->order->$cv_method->delivery_term_id);
316 ->replaceWith('#order_cp_id', $self->build_contact_select)
317 ->replaceWith('#order_shipto_id', $self->build_shipto_select)
318 ->val( '#order_taxzone_id', $self->order->taxzone_id)
319 ->val( '#order_taxincluded', $self->order->taxincluded)
320 ->val( '#order_payment_id', $self->order->payment_id)
321 ->val( '#order_delivery_term_id', $self->order->delivery_term_id)
322 ->val( '#order_intnotes', $self->order->$cv_method->notes)
323 ->focus( '#order_' . $self->cv . '_id');
325 $self->_js_redisplay_amounts_and_taxes;
329 sub action_add_item {
332 my $form_attr = $::form->{add_item};
334 return unless $form_attr->{parts_id};
336 my $item = SL::DB::OrderItem->new;
337 $item->assign_attributes(%$form_attr);
339 my $part = SL::DB::Part->new(id => $form_attr->{parts_id})->load;
341 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
344 if ($item->sellprice) {
345 $price_src = $price_source->price_from_source("");
346 $price_src->price($item->sellprice);
348 $price_src = $price_source->best_price
349 ? $price_source->best_price
350 : $price_source->price_from_source("");
351 $price_src->price(0) if !$price_source->best_price;
355 if ($item->discount) {
356 $discount_src = $price_source->discount_from_source("");
357 $discount_src->discount($item->discount);
359 $discount_src = $price_source->best_discount
360 ? $price_source->best_discount
361 : $price_source->discount_from_source("");
362 $discount_src->discount(0) if !$price_source->best_discount;
366 $new_attr{part} = $part;
367 $new_attr{description} = $part->description if ! $item->description;
368 $new_attr{qty} = 1.0 if ! $item->qty;
369 $new_attr{sellprice} = $price_src->price;
370 $new_attr{discount} = $discount_src->discount;
371 $new_attr{active_price_source} = $price_src;
372 $new_attr{active_discount_source} = $discount_src;
374 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
375 # they cannot be retrieved via custom_variables until the order/orderitem is
376 # saved. Adding empty custom_variables to new orderitem here solves this problem.
377 $new_attr{custom_variables} = [];
379 $item->assign_attributes(%new_attr);
381 $self->order->add_items($item);
385 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
386 my $row_as_html = $self->p->render('order/tabs/_row', ITEM => $item, ID => $item_id);
389 ->append('#row_table_id', $row_as_html)
390 ->val('.add_item_input', '')
391 ->run('row_table_scroll_down')
392 ->run('row_set_keyboard_events_by_id', $item_id)
393 ->on('.recalc', 'change', 'recalc_amounts_and_taxes')
394 ->on('.reformat_number', 'change', 'reformat_number')
395 ->focus('#add_item_parts_id_name');
397 $self->_js_redisplay_amounts_and_taxes;
401 sub action_recalc_amounts_and_taxes {
406 $self->_js_redisplay_linetotals;
407 $self->_js_redisplay_amounts_and_taxes;
411 sub action_price_popup {
414 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
415 my $item = $self->order->items->[$idx];
417 $self->render_price_dialog($item);
420 sub _js_redisplay_linetotals {
423 my @data = map {$::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0)} @{ $self->order->items };
425 ->run('redisplay_linetotals', \@data);
428 sub _js_redisplay_amounts_and_taxes {
431 if (scalar @{ $self->{taxes} }) {
432 $self->js->show('#taxincluded_row_id');
434 $self->js->hide('#taxincluded_row_id');
437 if ($self->order->taxincluded) {
438 $self->js->hide('#subtotal_row_id');
440 $self->js->show('#subtotal_row_id');
444 ->html('#netamount_id', $::form->format_amount(\%::myconfig, $self->order->netamount, -2))
445 ->html('#amount_id', $::form->format_amount(\%::myconfig, $self->order->amount, -2))
447 ->insertBefore($self->build_tax_rows, '#amount_row_id');
454 sub init_valid_types {
455 [ _sales_order_type(), _purchase_order_type() ];
461 if (none { $::form->{type} eq $_ } @{$self->valid_types}) {
462 die "Not a valid type for order";
465 $self->type($::form->{type});
471 my $cv = $self->type eq _sales_order_type() ? 'customer'
472 : $self->type eq _purchase_order_type() ? 'vendor'
473 : die "Not a valid type for order";
489 my $right_for = { map { $_ => $_.'_edit' } @{$self->valid_types} };
491 my $right = $right_for->{ $self->type };
492 $right ||= 'DOES_NOT_EXIST';
494 $::auth->assert($right);
497 sub build_contact_select {
500 $self->p->select_tag('order.cp_id', [ $self->order->{$self->cv}->contacts ],
501 value_key => 'cp_id',
502 title_key => 'full_name_dep',
503 default => $self->order->cp_id,
505 style => 'width: 300px',
509 sub build_shipto_select {
512 $self->p->select_tag('order.shipto_id', [ $self->order->{$self->cv}->shipto ],
513 value_key => 'shipto_id',
514 title_key => 'displayable_id',
515 default => $self->order->shipto_id,
517 style => 'width: 300px',
525 foreach my $tax (sort { $a->{tax}->rate cmp $b->{tax}->rate } @{ $self->{taxes} }) {
526 $rows_as_html .= $self->p->render('order/tabs/_tax_row', TAX => $tax, TAXINCLUDED => $self->order->taxincluded);
528 return $rows_as_html;
532 sub render_price_dialog {
533 my ($self, $record_item) = @_;
535 my $price_source = SL::PriceSource->new(record_item => $record_item, record => $self->order);
539 'kivi.io.price_chooser_dialog',
540 t8('Available Prices'),
541 $self->render('order/tabs/_price_sources_dialog', { output => 0 }, price_source => $price_source)
546 # $self->js->text('#dialog_flash_error_content', join ' ', @errors);
547 # $self->js->show('#dialog_flash_error');
556 # add_items adds items to an order with no items for saving, but they cannot
557 # be retrieved via items until the order is saved. Adding empty items to new
558 # order here solves this problem.
560 $order = SL::DB::Manager::Order->find_by(id => $::form->{id}) if $::form->{id};
561 $order ||= SL::DB::Order->new(orderitems => []);
563 $order->assign_attributes(%{$::form->{order}});
571 # bb: todo: currency later
572 $self->order->currency_id($::instance_conf->get_currency_id());
574 my %pat = $self->order->calculate_prices_and_taxes();
576 foreach my $tax_chart_id (keys %{ $pat{taxes} }) {
577 my $tax = SL::DB::Manager::Tax->find_by(chart_id => $tax_chart_id);
579 my @amount_keys = grep { $pat{amounts}->{$_}->{tax_id} == $tax->id } keys %{ $pat{amounts} };
580 push(@{ $self->{taxes} }, { amount => $pat{taxes}->{$tax_chart_id},
581 netamount => $pat{amounts}->{$amount_keys[0]}->{amount},
585 pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items}, @{$pat{items}};
589 sub _get_unalterable_data {
592 foreach my $item (@{ $self->order->items }) {
594 # load data from orderitems (db)
595 my $db_item = SL::DB::OrderItem->new(id => $item->id)->load;
596 $item->$_($db_item->$_) for qw(longdescription);
598 # set data from part (or other sources)
599 $item->longdescription($item->part->notes);
602 # autovivify all cvars that are not in the form (cvars_by_config can do it).
603 # workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
604 foreach my $var (@{ $item->cvars_by_config }) {
605 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
607 $item->parse_custom_variable_values;
616 my $db = $self->order->db;
620 my @spoolfiles = grep { $_ } map { $_->spoolfile } @{ SL::DB::Manager::Status->get_all(where => [ trans_id => $self->order->id ]) };
621 $self->order->delete;
622 my $spool = $::lx_office_conf{paths}->{spool};
623 unlink map { "$spool/$_" } @spoolfiles if $spool;
626 }) || push(@{$errors}, $db->error);
636 my $db = $self->order->db;
640 $self->order->save();
641 }) || push(@{$errors}, $db->error);
650 $self->{all_taxzones} = SL::DB::Manager::TaxZone->get_all_sorted();
651 $self->{all_departments} = SL::DB::Manager::Department->get_all_sorted();
652 $self->{all_employees} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->employee_id,
655 $self->{all_salesmen} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->salesman_id,
658 $self->{all_projects} = SL::DB::Manager::Project->get_all(where => [ or => [ id => $self->order->globalproject_id,
660 sort_by => 'projectnumber');
661 $self->{all_payment_terms} = SL::DB::Manager::PaymentTerm->get_all_sorted();
662 $self->{all_delivery_terms} = SL::DB::Manager::DeliveryTerm->get_all_sorted();
664 $self->{current_employee_id} = SL::DB::Manager::Employee->current->id;
666 foreach my $item (@{$self->order->items}) {
667 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
668 $item->active_price_source( $price_source->price_from_source( $item->active_price_source ));
669 $item->active_discount_source($price_source->discount_from_source($item->active_discount_source));
673 if ($self->order->ordnumber && $::instance_conf->get_webdav) {
674 my $webdav = SL::Webdav->new(
676 number => $self->order->ordnumber,
678 my $webdav_path = $webdav->webdav_path;
679 my @all_objects = $webdav->get_all_objects;
680 @{ $self->{template_args}->{WEBDAV} } = map { { name => $_->filename,
682 link => File::Spec->catdir($webdav_path, $_->filename),
686 $::request->{layout}->use_javascript("${_}.js") for qw(ckeditor/ckeditor ckeditor/adapters/jquery);
690 my ($order, $pdf_ref, $params) = @_;
692 my $print_form = Form->new('');
693 $print_form->{type} = $order->type;
694 $print_form->{formname} = $order->type;
695 $print_form->{format} = $params->{format} || 'pdf',
696 $print_form->{media} = $params->{media} || 'file';
698 $order->flatten_to_form($print_form, format_amounts => 1);
699 # flatten_to_form sets payment_terms from customer/vendor - we do not want that here
700 delete $print_form->{payment_terms} if !$print_form->{payment_id};
703 $print_form->throw_on_error(sub {
705 $print_form->prepare_for_printing;
707 $$pdf_ref = SL::Helper::CreatePDF->create_pdf(
708 template => SL::Helper::CreatePDF->find_template(name => $print_form->{formname}),
709 variables => $print_form,
710 variable_content_types => {
711 longdescription => 'html',
717 } || push @errors, ref($EVAL_ERROR) eq 'SL::X::FormError' ? $EVAL_ERROR->getMessage : $EVAL_ERROR;
723 sub _sales_order_type {
727 sub _purchase_order_type {