1 package SL::Controller::Order;
4 use parent qw(SL::Controller::Base);
8 use SL::Locale::String;
9 use SL::SessionFile::Random;
23 use SL::Helper::DateTime;
24 use SL::Helper::CreatePDF qw(:all);
26 use List::Util qw(max first);
27 use List::MoreUtils qw(none pairwise first_index);
28 use English qw(-no_match_vars);
31 use Rose::Object::MakeMethods::Generic
33 'scalar --get_set_init' => [ qw(order valid_types type cv p) ],
38 __PACKAGE__->run_before('_check_auth');
40 __PACKAGE__->run_before('_recalc',
41 only => [ qw(edit update save save_and_delivery_order create_pdf send_email) ]);
43 __PACKAGE__->run_before('_get_unalterable_data',
44 only => [ qw(save save_and_delivery_order create_pdf send_email) ]);
53 $self->order->transdate(DateTime->now_local());
58 title => $self->type eq _sales_order_type() ? $::locale->text('Add Sales Order')
59 : $self->type eq _purchase_order_type() ? $::locale->text('Add Purchase Order')
61 %{$self->{template_args}}
71 title => $self->type eq _sales_order_type() ? $::locale->text('Edit Sales Order')
72 : $self->type eq _purchase_order_type() ? $::locale->text('Edit Purchase Order')
74 %{$self->{template_args}}
84 title => $self->type eq _sales_order_type() ? $::locale->text('Edit Sales Order')
85 : $self->type eq _purchase_order_type() ? $::locale->text('Edit Purchase Order')
87 %{$self->{template_args}}
94 my $errors = $self->_save();
96 if (scalar @{ $errors }) {
97 $self->js->flash('error', $_) foreach @{ $errors };
98 return $self->js->render();
101 flash_later('info', $::locale->text('The order has been saved'));
102 my @redirect_params = (
105 id => $self->order->id,
108 $self->redirect_to(@redirect_params);
111 sub action_create_pdf {
115 my @errors = _create_pdf($self->order, \$pdf);
116 if (scalar @errors) {
117 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
120 my $sfile = SL::SessionFile::Random->new(mode => "w");
121 $sfile->fh->print($pdf);
124 my $key = join('_', Time::HiRes::gettimeofday(), int rand 1000000000000);
125 $::auth->set_session_value("Order::create_pdf-${key}" => $sfile->file_name);
127 $::form->{formname} = $self->type;
128 $::form->{language} = 'de';
129 my $pdf_filename = $::form->get_formname_translation . '_' . $self->order->ordnumber . '.pdf';
132 ->run('download_pdf', $pdf_filename, $key)
133 ->flash('info', t8('The PDF has been created'))->render($self);
136 sub action_download_pdf {
139 my $key = $::form->{key};
140 my $tmp_filename = $::auth->get_session_value("Order::create_pdf-${key}");
141 return $self->send_file(
143 type => 'application/pdf',
144 name => $::form->{pdf_filename},
148 sub action_show_email_dialog {
151 my $cv_method = $self->cv;
153 if (!$self->order->$cv_method) {
154 return $self->js->flash('error', t8('Cannot send E-mail without ' . $self->cv))
158 $self->{email}->{to} = $self->order->contact->cp_email if $self->order->contact;
159 $self->{email}->{to} ||= $self->order->$cv_method->email;
160 $self->{email}->{cc} = $self->order->$cv_method->cc;
161 $self->{email}->{bcc} = join ', ', grep $_, $self->order->$cv_method->bcc, SL::DB::Default->get->global_bcc;
162 # Todo: get addresses from shipto, if any
164 my $form = Form->new;
165 $form->{ordnumber} = $self->order->ordnumber;
166 $form->{formname} = $self->type;
167 $form->{type} = $self->type;
168 $form->{language} = 'de';
169 $form->{format} = 'pdf';
171 $self->{email}->{subject} = $form->generate_email_subject();
172 $self->{email}->{attachment_filename} = $form->generate_attachment_filename();
173 $self->{email}->{message} = $form->create_email_signature();
175 my $dialog_html = $self->render('order/tabs/_email_dialog', { output => 0 });
177 ->run('show_email_dialog', $dialog_html)
182 # Todo: handling error messages: flash is not displayed in dialog, but in the main form
183 sub action_send_email {
186 my $mail = Mailer->new;
187 $mail->{from} = qq|"$::myconfig{name}" <$::myconfig{email}>|;
188 $mail->{$_} = $::form->{email}->{$_} for qw(to cc bcc subject message);
191 my @errors = _create_pdf($self->order, \$pdf, {media => 'email'});
192 if (scalar @errors) {
193 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
196 $mail->{attachments} = [{ "content" => $pdf,
197 "name" => $::form->{email}->{attachment_filename} }];
199 if (my $err = $mail->send) {
200 return $self->js->flash('error', t8('Sending E-mail: ') . $err)
205 my $intnotes = $self->order->intnotes;
206 $intnotes .= "\n\n" if $self->order->intnotes;
207 $intnotes .= t8('[email]') . "\n";
208 $intnotes .= t8('Date') . ": " . $::locale->format_date_object(DateTime->now_local, precision => 'seconds') . "\n";
209 $intnotes .= t8('To (email)') . ": " . $mail->{to} . "\n";
210 $intnotes .= t8('Cc') . ": " . $mail->{cc} . "\n" if $mail->{cc};
211 $intnotes .= t8('Bcc') . ": " . $mail->{bcc} . "\n" if $mail->{bcc};
212 $intnotes .= t8('Subject') . ": " . $mail->{subject} . "\n\n";
213 $intnotes .= t8('Message') . ": " . $mail->{message};
216 ->val('#order_intnotes', $intnotes)
217 ->run('close_email_dialog')
221 sub action_save_and_delivery_order {
224 my $errors = $self->_save();
226 if (scalar @{ $errors }) {
227 $self->js->flash('error', $_) foreach @{ $errors };
228 return $self->js->render();
231 my $delivery_order = $self->order->convert_to_delivery_order($self->order);
233 flash_later('info', $::locale->text('The order has been saved'));
234 my @redirect_params = (
235 controller => 'do.pl',
237 type => $delivery_order->type,
238 id => $delivery_order->id,
239 vc => $delivery_order->is_sales ? 'customer' : 'vendor',
242 $self->redirect_to(@redirect_params);
245 sub action_customer_vendor_changed {
248 my $cv_method = $self->cv;
250 if ($self->order->$cv_method->contacts && scalar @{ $self->order->$cv_method->contacts } > 0) {
251 $self->js->show('#cp_row');
253 $self->js->hide('#cp_row');
256 if ($self->order->$cv_method->shipto && scalar @{ $self->order->$cv_method->shipto } > 0) {
257 $self->js->show('#shipto_row');
259 $self->js->hide('#shipto_row');
262 $self->order->taxzone_id($self->order->$cv_method->taxzone_id);
264 if ($self->order->is_sales) {
265 $self->order->taxincluded(defined($self->order->$cv_method->taxincluded_checked)
266 ? $self->order->$cv_method->taxincluded_checked
267 : $::myconfig{taxincluded_checked});
273 ->replaceWith('#order_cp_id', $self->build_contact_select)
274 ->replaceWith('#order_shipto_id', $self->build_shipto_select)
275 ->val( '#order_taxzone_id', $self->order->taxzone_id)
276 ->val( '#order_taxincluded', $self->order->taxincluded)
277 ->focus( '#order_' . $self->cv . '_id');
279 $self->_js_redisplay_amounts_and_taxes;
283 sub action_add_item {
286 my $form_attr = $::form->{add_item};
288 return unless $form_attr->{parts_id};
290 my $item = SL::DB::OrderItem->new;
291 $item->assign_attributes(%$form_attr);
293 my $part = SL::DB::Part->new(id => $form_attr->{parts_id})->load;
295 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
298 if ($item->sellprice) {
299 $price_src = $price_source->price_from_source("");
300 $price_src->price($item->sellprice);
302 $price_src = $price_source->best_price
303 ? $price_source->best_price
304 : $price_source->price_from_source("");
305 $price_src->price(0) if !$price_source->best_price;
308 # bb: not sure but: maybe there should be a $price_source->discount_from_source
309 # which can alse return an empty_discout if source is "".
312 if ($item->discount) {
313 $discount = $item->discount;
315 $discount = $price_source->best_discount
316 ? $price_source->best_discount->discount
318 $discount_src = $price_source->best_discount->source if $price_source->best_discount;
322 $new_attr{part} = $part;
323 $new_attr{description} = $part->description if ! $item->description;
324 $new_attr{qty} = 1.0 if ! $item->qty;
325 $new_attr{sellprice} = $price_src->price;
326 $new_attr{discount} = $discount;
327 $new_attr{active_price_source} = $price_src;
328 $new_attr{active_discount_source} = $discount_src;
330 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
331 # they cannot be retrieved via custom_variables until the order/orderitem is
332 # saved. Adding empty custom_variables to new orderitem here solves this problem.
333 $new_attr{custom_variables} = [];
335 $item->assign_attributes(%new_attr);
337 $self->order->add_items($item);
341 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
342 my $row_as_html = $self->p->render('order/tabs/_row', ITEM => $item, ID => $item_id);
345 ->append('#row_table_id', $row_as_html)
346 ->val('#add_item_parts_id', '')
347 ->val('#add_item_parts_id_name', '')
348 ->val('#add_item_description', '')
349 ->val('#add_item_qty_as_number', '')
350 ->val('#add_item_sellprice_as_number', '')
351 ->val('#add_item_discount_as_percent', '')
352 ->run('row_table_scroll_down')
353 ->run('row_set_keyboard_events_by_id', $item_id)
354 ->on('.recalc', 'change', 'recalc_amounts_and_taxes')
355 ->focus('#add_item_parts_id_name');
357 $self->_js_redisplay_amounts_and_taxes;
361 sub action_recalc_amounts_and_taxes {
366 $self->_js_redisplay_linetotals;
367 $self->_js_redisplay_amounts_and_taxes;
371 sub action_price_popup {
374 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
375 my $item = $self->order->items->[$idx];
377 $self->render_price_dialog($item);
380 sub _js_redisplay_linetotals {
383 my @data = map {$::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0)} @{ $self->order->items };
385 ->run('redisplay_linetotals', \@data);
388 sub _js_redisplay_amounts_and_taxes {
391 if (scalar @{ $self->{taxes} }) {
392 $self->js->show('#taxincluded_row_id');
394 $self->js->hide('#taxincluded_row_id');
397 if ($self->order->taxincluded) {
398 $self->js->hide('#subtotal_row_id');
400 $self->js->show('#subtotal_row_id');
404 ->html('#netamount_id', $::form->format_amount(\%::myconfig, $self->order->netamount, -2))
405 ->html('#amount_id', $::form->format_amount(\%::myconfig, $self->order->amount, -2))
407 ->insertBefore($self->build_tax_rows, '#amount_row_id');
414 sub init_valid_types {
415 [ _sales_order_type(), _purchase_order_type() ];
421 if (none { $::form->{type} eq $_ } @{$self->valid_types}) {
422 die "Not a valid type for order";
425 $self->type($::form->{type});
431 my $cv = $self->type eq _sales_order_type() ? 'customer'
432 : $self->type eq _purchase_order_type() ? 'vendor'
433 : die "Not a valid type for order";
449 my $right_for = { map { $_ => $_.'_edit' } @{$self->valid_types} };
451 my $right = $right_for->{ $self->type };
452 $right ||= 'DOES_NOT_EXIST';
454 $::auth->assert($right);
457 sub build_contact_select {
460 $self->p->select_tag('order.cp_id', [ $self->order->{$self->cv}->contacts ],
461 value_key => 'cp_id',
462 title_key => 'full_name_dep',
463 default => $self->order->cp_id,
465 style => 'width: 300px',
469 sub build_shipto_select {
472 $self->p->select_tag('order.shipto_id', [ $self->order->{$self->cv}->shipto ],
473 value_key => 'shipto_id',
474 title_key => 'displayable_id',
475 default => $self->order->shipto_id,
477 style => 'width: 300px',
485 foreach my $tax (sort { $a->{tax}->rate cmp $b->{tax}->rate } @{ $self->{taxes} }) {
486 $rows_as_html .= $self->p->render('order/tabs/_tax_row', TAX => $tax, TAXINCLUDED => $self->order->taxincluded);
488 return $rows_as_html;
492 sub render_price_dialog {
493 my ($self, $record_item) = @_;
495 my $price_source = SL::PriceSource->new(record_item => $record_item, record => $self->order);
499 'kivi.io.price_chooser_dialog',
500 t8('Available Prices'),
501 $self->render('order/tabs/_price_sources_dialog', { output => 0 }, price_source => $price_source)
506 # $self->js->text('#dialog_flash_error_content', join ' ', @errors);
507 # $self->js->show('#dialog_flash_error');
516 # add_items adds items to an order with no items for saving, but they cannot
517 # be retrieved via items until the order is saved. Adding empty items to new
518 # order here solves this problem.
520 $order = SL::DB::Manager::Order->find_by(id => $::form->{id}) if $::form->{id};
521 $order ||= SL::DB::Order->new(orderitems => []);
523 $order->assign_attributes(%{$::form->{order}});
531 # bb: todo: currency later
532 $self->order->currency_id($::instance_conf->get_currency_id());
534 my %pat = $self->order->calculate_prices_and_taxes();
536 foreach my $tax_chart_id (keys %{ $pat{taxes} }) {
537 my $tax = SL::DB::Manager::Tax->find_by(chart_id => $tax_chart_id);
539 my @amount_keys = grep { $pat{amounts}->{$_}->{tax_id} == $tax->id } keys %{ $pat{amounts} };
540 push(@{ $self->{taxes} }, { amount => $pat{taxes}->{$tax_chart_id},
541 netamount => $pat{amounts}->{$amount_keys[0]}->{amount},
545 pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items}, @{$pat{items}};
549 sub _get_unalterable_data {
552 foreach my $item (@{ $self->order->items }) {
554 # load data from orderitems (db)
555 my $db_item = SL::DB::OrderItem->new(id => $item->id)->load;
556 $item->$_($db_item->$_) for qw(longdescription);
558 # set data from part (or other sources)
559 $item->longdescription($item->part->notes);
562 # autovivify all cvars that are not in the form (cvars_by_config can do it).
563 # workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
564 foreach my $var (@{ $item->cvars_by_config }) {
565 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
567 $item->parse_custom_variable_values;
576 my $db = $self->order->db;
580 $self->order->save();
581 }) || push(@{$errors}, $db->error);
590 $self->{all_taxzones} = SL::DB::Manager::TaxZone->get_all_sorted();
591 $self->{all_employees} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->employee_id,
594 $self->{all_salesmen} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->salesman_id,
597 $self->{all_projects} = SL::DB::Manager::Project->get_all(where => [ or => [ id => $self->order->globalproject_id,
599 sort_by => 'projectnumber');
600 $self->{all_payment_terms} = SL::DB::Manager::PaymentTerm->get_all_sorted();
601 $self->{all_delivery_terms} = SL::DB::Manager::DeliveryTerm->get_all_sorted();
603 $self->{current_employee_id} = SL::DB::Manager::Employee->current->id;
605 foreach my $item (@{$self->order->items}) {
606 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
608 my $price_src = $price_source->price_from_source($item->active_price_source);
609 $item->active_price_source($price_src);
612 $discount_src = $price_source->price_from_source($item->active_discount_source)->source if $item->active_discount_source;
613 $item->active_discount_source($discount_src);
616 $::request->{layout}->use_javascript("${_}.js") for qw(ckeditor/ckeditor ckeditor/adapters/jquery);
620 my ($order, $pdf_ref, $params) = @_;
622 my $print_form = Form->new('');
623 $print_form->{type} = $order->type;
624 $print_form->{formname} = $order->type;
625 $print_form->{format} = $params->{format} || 'pdf',
626 $print_form->{media} = $params->{media} || 'file';
628 $order->flatten_to_form($print_form, format_amounts => 1);
629 # flatten_to_form sets payment_terms from customer/vendor - we do not want that here
630 delete $print_form->{payment_terms} if !$print_form->{payment_id};
633 $print_form->throw_on_error(sub {
635 $print_form->prepare_for_printing;
637 $$pdf_ref = SL::Helper::CreatePDF->create_pdf(
638 template => SL::Helper::CreatePDF->find_template(name => $print_form->{formname}),
639 variables => $print_form,
640 variable_content_types => {
641 longdescription => 'html',
647 } || push @errors, ref($EVAL_ERROR) eq 'SL::X::FormError' ? $EVAL_ERROR->getMessage : $EVAL_ERROR;
653 sub _sales_order_type {
657 sub _purchase_order_type {
669 SL::Controller::Order - controller for orders
673 Testing, PriceSources, pricefactor, units, currency, delivered, delivery order created, ...
677 Bernd Bleßmann E<lt>bernd@kivitendo-premium.deE<gt>