1 package SL::Controller::Order;
4 use parent qw(SL::Controller::Base);
8 use SL::Locale::String;
9 use SL::SessionFile::Random;
22 use SL::Helper::DateTime;
23 use SL::Helper::CreatePDF qw(:all);
25 use List::Util qw(max first);
26 use List::MoreUtils qw(none pairwise);
27 use English qw(-no_match_vars);
30 use Rose::Object::MakeMethods::Generic
32 'scalar --get_set_init' => [ qw(order valid_types type cv p) ],
37 __PACKAGE__->run_before('_check_auth');
39 __PACKAGE__->run_before('_recalc',
40 only => [ qw(edit update save create_pdf send_email) ]);
42 __PACKAGE__->run_before('_get_unalterable_data',
43 only => [ qw(save save_and_delivery_order create_pdf send_email) ]);
52 $self->order->transdate(DateTime->now_local());
57 title => $self->type eq _sales_order_type() ? $::locale->text('Add Sales Order')
58 : $self->type eq _purchase_order_type() ? $::locale->text('Add Purchase Order')
60 %{$self->{template_args}}
70 title => $self->type eq _sales_order_type() ? $::locale->text('Edit Sales Order')
71 : $self->type eq _purchase_order_type() ? $::locale->text('Edit Purchase Order')
73 %{$self->{template_args}}
83 title => $self->type eq _sales_order_type() ? $::locale->text('Edit Sales Order')
84 : $self->type eq _purchase_order_type() ? $::locale->text('Edit Purchase Order')
86 %{$self->{template_args}}
93 my $errors = $self->_delete();
95 if (scalar @{ $errors }) {
96 $self->js->flash('error', $_) foreach @{ $errors };
97 return $self->js->render();
100 flash_later('info', $::locale->text('The order has been deleted'));
101 my @redirect_params = (
106 $self->redirect_to(@redirect_params);
112 my $errors = $self->_save();
114 if (scalar @{ $errors }) {
115 $self->js->flash('error', $_) foreach @{ $errors };
116 return $self->js->render();
119 flash_later('info', $::locale->text('The order has been saved'));
120 my @redirect_params = (
123 id => $self->order->id,
126 $self->redirect_to(@redirect_params);
129 sub action_create_pdf {
133 my @errors = _create_pdf($self->order, \$pdf);
134 if (scalar @errors) {
135 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
138 my $sfile = SL::SessionFile::Random->new(mode => "w");
139 $sfile->fh->print($pdf);
142 my $key = join('_', Time::HiRes::gettimeofday(), int rand 1000000000000);
143 $::auth->set_session_value("Order::create_pdf-${key}" => $sfile->file_name);
145 my $form = Form->new;
146 $form->{ordnumber} = $self->order->ordnumber;
147 $form->{formname} = $self->type;
148 $form->{type} = $self->type;
149 $form->{language} = 'de';
150 $form->{format} = 'pdf';
152 my $pdf_filename = $form->generate_attachment_filename();
155 ->run('download_pdf', $pdf_filename, $key)
156 ->flash('info', t8('The PDF has been created'))->render($self);
159 sub action_download_pdf {
162 my $key = $::form->{key};
163 my $tmp_filename = $::auth->get_session_value("Order::create_pdf-${key}");
164 return $self->send_file(
166 type => 'application/pdf',
167 name => $::form->{pdf_filename},
171 sub action_show_email_dialog {
174 my $cv_method = $self->cv;
176 if (!$self->order->$cv_method) {
177 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'))
181 $self->{email}->{to} = $self->order->contact->cp_email if $self->order->contact;
182 $self->{email}->{to} ||= $self->order->$cv_method->email;
183 $self->{email}->{cc} = $self->order->$cv_method->cc;
184 $self->{email}->{bcc} = join ', ', grep $_, $self->order->$cv_method->bcc, SL::DB::Default->get->global_bcc;
185 # Todo: get addresses from shipto, if any
187 my $form = Form->new;
188 $form->{ordnumber} = $self->order->ordnumber;
189 $form->{formname} = $self->type;
190 $form->{type} = $self->type;
191 $form->{language} = 'de';
192 $form->{format} = 'pdf';
194 $self->{email}->{subject} = $form->generate_email_subject();
195 $self->{email}->{attachment_filename} = $form->generate_attachment_filename();
196 $self->{email}->{message} = $form->create_email_signature();
198 my $dialog_html = $self->render('order/tabs/_email_dialog', { output => 0 });
200 ->run('show_email_dialog', $dialog_html)
205 # Todo: handling error messages: flash is not displayed in dialog, but in the main form
206 sub action_send_email {
209 my $mail = Mailer->new;
210 $mail->{from} = qq|"$::myconfig{name}" <$::myconfig{email}>|;
211 $mail->{$_} = $::form->{email}->{$_} for qw(to cc bcc subject message);
214 my @errors = _create_pdf($self->order, \$pdf, {media => 'email'});
215 if (scalar @errors) {
216 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
219 $mail->{attachments} = [{ "content" => $pdf,
220 "name" => $::form->{email}->{attachment_filename} }];
222 if (my $err = $mail->send) {
223 return $self->js->flash('error', t8('Sending E-mail: ') . $err)
228 my $intnotes = $self->order->intnotes;
229 $intnotes .= "\n\n" if $self->order->intnotes;
230 $intnotes .= t8('[email]') . "\n";
231 $intnotes .= t8('Date') . ": " . $::locale->format_date_object(DateTime->now_local, precision => 'seconds') . "\n";
232 $intnotes .= t8('To (email)') . ": " . $mail->{to} . "\n";
233 $intnotes .= t8('Cc') . ": " . $mail->{cc} . "\n" if $mail->{cc};
234 $intnotes .= t8('Bcc') . ": " . $mail->{bcc} . "\n" if $mail->{bcc};
235 $intnotes .= t8('Subject') . ": " . $mail->{subject} . "\n\n";
236 $intnotes .= t8('Message') . ": " . $mail->{message};
239 ->val('#order_intnotes', $intnotes)
240 ->run('close_email_dialog')
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});
270 $self->order->payment_id($self->order->$cv_method->payment_id);
271 $self->order->delivery_term_id($self->order->$cv_method->delivery_term_id);
276 ->replaceWith('#order_cp_id', $self->build_contact_select)
277 ->replaceWith('#order_shipto_id', $self->build_shipto_select)
278 ->val( '#order_taxzone_id', $self->order->taxzone_id)
279 ->val( '#order_taxincluded', $self->order->taxincluded)
280 ->val( '#order_payment_id', $self->order->payment_id)
281 ->val( '#order_delivery_term_id', $self->order->delivery_term_id)
282 ->val( '#order_intnotes', $self->order->$cv_method->notes)
283 ->focus( '#order_' . $self->cv . '_id');
285 $self->_js_redisplay_amounts_and_taxes;
289 sub action_add_item {
292 my $form_attr = $::form->{add_item};
294 return unless $form_attr->{parts_id};
296 my $item = SL::DB::OrderItem->new;
297 $item->assign_attributes(%$form_attr);
299 my $part = SL::DB::Part->new(id => $form_attr->{parts_id})->load;
300 my $cv_method = $self->cv;
301 my $cv_discount = $self->order->$cv_method? $self->order->$cv_method->discount : 0.0;
304 $new_attr{part} = $part;
305 $new_attr{description} = $part->description if ! $item->description;
306 $new_attr{qty} = 1.0 if ! $item->qty;
307 $new_attr{unit} = $part->unit;
308 $new_attr{sellprice} = $part->sellprice if ! $item->sellprice;
309 $new_attr{discount} = $cv_discount if ! $item->discount;
311 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
312 # they cannot be retrieved via custom_variables until the order/orderitem is
313 # saved. Adding empty custom_variables to new orderitem here solves this problem.
314 $new_attr{custom_variables} = [];
316 $item->assign_attributes(%new_attr);
318 $self->order->add_items($item);
322 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
323 my $row_as_html = $self->p->render('order/tabs/_row', ITEM => $item, ID => $item_id);
326 ->append('#row_table_id', $row_as_html)
327 ->val('.add_item_input', '')
328 ->run('row_table_scroll_down')
329 ->run('row_set_keyboard_events_by_id', $item_id)
330 ->on('.recalc', 'change', 'recalc_amounts_and_taxes')
331 ->focus('#add_item_parts_id_name');
333 $self->_js_redisplay_amounts_and_taxes;
337 sub action_recalc_amounts_and_taxes {
342 $self->_js_redisplay_linetotals;
343 $self->_js_redisplay_amounts_and_taxes;
347 sub _js_redisplay_linetotals {
350 my @data = map {$::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0)} @{ $self->order->items };
352 ->run('redisplay_linetotals', \@data);
355 sub _js_redisplay_amounts_and_taxes {
358 if (scalar @{ $self->{taxes} }) {
359 $self->js->show('#taxincluded_row_id');
361 $self->js->hide('#taxincluded_row_id');
364 if ($self->order->taxincluded) {
365 $self->js->hide('#subtotal_row_id');
367 $self->js->show('#subtotal_row_id');
371 ->html('#netamount_id', $::form->format_amount(\%::myconfig, $self->order->netamount, -2))
372 ->html('#amount_id', $::form->format_amount(\%::myconfig, $self->order->amount, -2))
374 ->insertBefore($self->build_tax_rows, '#amount_row_id');
381 sub init_valid_types {
382 [ _sales_order_type(), _purchase_order_type() ];
388 if (none { $::form->{type} eq $_ } @{$self->valid_types}) {
389 die "Not a valid type for order";
392 $self->type($::form->{type});
398 my $cv = $self->type eq _sales_order_type() ? 'customer'
399 : $self->type eq _purchase_order_type() ? 'vendor'
400 : die "Not a valid type for order";
416 my $right_for = { map { $_ => $_.'_edit' } @{$self->valid_types} };
418 my $right = $right_for->{ $self->type };
419 $right ||= 'DOES_NOT_EXIST';
421 $::auth->assert($right);
424 sub build_contact_select {
427 $self->p->select_tag('order.cp_id', [ $self->order->{$self->cv}->contacts ],
428 value_key => 'cp_id',
429 title_key => 'full_name_dep',
430 default => $self->order->cp_id,
432 style => 'width: 300px',
436 sub build_shipto_select {
439 $self->p->select_tag('order.shipto_id', [ $self->order->{$self->cv}->shipto ],
440 value_key => 'shipto_id',
441 title_key => 'displayable_id',
442 default => $self->order->shipto_id,
444 style => 'width: 300px',
452 foreach my $tax (sort { $a->{tax}->rate cmp $b->{tax}->rate } @{ $self->{taxes} }) {
453 $rows_as_html .= $self->p->render('order/tabs/_tax_row', TAX => $tax, TAXINCLUDED => $self->order->taxincluded);
455 return $rows_as_html;
462 # add_items adds items to an order with no items for saving, but they cannot
463 # be retrieved via items until the order is saved. Adding empty items to new
464 # order here solves this problem.
466 $order = SL::DB::Manager::Order->find_by(id => $::form->{id}) if $::form->{id};
467 $order ||= SL::DB::Order->new(orderitems => []);
469 $order->assign_attributes(%{$::form->{order}});
478 # bb: todo: currency later
479 $self->order->currency_id($::instance_conf->get_currency_id());
481 my %pat = $self->order->calculate_prices_and_taxes();
483 foreach my $tax_chart_id (keys %{ $pat{taxes} }) {
484 my $tax = SL::DB::Manager::Tax->find_by(chart_id => $tax_chart_id);
486 my @amount_keys = grep { $pat{amounts}->{$_}->{tax_id} == $tax->id } keys %{ $pat{amounts} };
487 push(@{ $self->{taxes} }, { amount => $pat{taxes}->{$tax_chart_id},
488 netamount => $pat{amounts}->{$amount_keys[0]}->{amount},
492 pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items}, @{$pat{items}};
496 sub _get_unalterable_data {
499 foreach my $item (@{ $self->order->items }) {
501 # load data from orderitems (db)
502 my $db_item = SL::DB::OrderItem->new(id => $item->id)->load;
503 $item->$_($db_item->$_) for qw(active_discount_source active_price_source longdescription);
505 # set data from part (or other sources)
506 $item->longdescription($item->part->notes);
507 #$item->active_price_source('');
508 #$item->active_discount_source('');
511 # autovivify all cvars that are not in the form (cvars_by_config can do it).
512 # workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
513 foreach my $var (@{ $item->cvars_by_config }) {
514 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
516 $item->parse_custom_variable_values;
525 my $db = $self->order->db;
529 my @spoolfiles = grep { $_ } map { $_->spoolfile } @{ SL::DB::Manager::Status->get_all(where => [ trans_id => $self->order->id ]) };
530 $self->order->delete;
531 my $spool = $::lx_office_conf{paths}->{spool};
532 unlink map { "$spool/$_" } @spoolfiles if $spool;
535 }) || push(@{$errors}, $db->error);
545 my $db = $self->order->db;
549 $self->order->save();
550 }) || push(@{$errors}, $db->error);
559 $self->{all_taxzones} = SL::DB::Manager::TaxZone->get_all_sorted();
560 $self->{all_employees} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->employee_id,
563 $self->{all_salesmen} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->salesman_id,
566 $self->{all_projects} = SL::DB::Manager::Project->get_all(where => [ or => [ id => $self->order->globalproject_id,
568 sort_by => 'projectnumber');
569 $self->{all_payment_terms} = SL::DB::Manager::PaymentTerm->get_all_sorted();
570 $self->{all_delivery_terms} = SL::DB::Manager::DeliveryTerm->get_all_sorted();
572 $self->{current_employee_id} = SL::DB::Manager::Employee->current->id;
574 $::request->{layout}->use_javascript("${_}.js") for qw(ckeditor/ckeditor ckeditor/adapters/jquery);
578 my ($order, $pdf_ref, $params) = @_;
580 my $print_form = Form->new('');
581 $print_form->{type} = $order->type;
582 $print_form->{formname} = $order->type;
583 $print_form->{format} = $params->{format} || 'pdf',
584 $print_form->{media} = $params->{media} || 'file';
586 $order->flatten_to_form($print_form, format_amounts => 1);
587 # flatten_to_form sets payment_terms from customer/vendor - we do not want that here
588 delete $print_form->{payment_terms} if !$print_form->{payment_id};
591 $print_form->throw_on_error(sub {
593 $print_form->prepare_for_printing;
595 $$pdf_ref = SL::Helper::CreatePDF->create_pdf(
596 template => SL::Helper::CreatePDF->find_template(name => $print_form->{formname}),
597 variables => $print_form,
598 variable_content_types => {
599 longdescription => 'html',
605 } || push @errors, ref($EVAL_ERROR) eq 'SL::X::FormError' ? $EVAL_ERROR->getMessage : $EVAL_ERROR;
611 sub _sales_order_type {
615 sub _purchase_order_type {