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);
29 use Rose::Object::MakeMethods::Generic
31 'scalar --get_set_init' => [ qw(order valid_types type cv p) ],
36 __PACKAGE__->run_before('_check_auth');
38 __PACKAGE__->run_before('_recalc',
39 only => [ qw(edit update save save_and_delivery_order create_pdf send_email) ]);
41 __PACKAGE__->run_before('_get_unalterable_data',
42 only => [ qw(save save_and_delivery_order create_pdf send_email) ]);
51 $self->order->transdate(DateTime->now_local());
56 title => $self->type eq _sales_order_type() ? $::locale->text('Add Sales Order')
57 : $self->type eq _purchase_order_type() ? $::locale->text('Add Purchase Order')
59 %{$self->{template_args}}
69 title => $self->type eq _sales_order_type() ? $::locale->text('Edit Sales Order')
70 : $self->type eq _purchase_order_type() ? $::locale->text('Edit Purchase Order')
72 %{$self->{template_args}}
82 title => $self->type eq _sales_order_type() ? $::locale->text('Edit Sales Order')
83 : $self->type eq _purchase_order_type() ? $::locale->text('Edit Purchase Order')
85 %{$self->{template_args}}
92 my $errors = $self->_save();
94 if (scalar @{ $errors }) {
95 $self->js->flash('error', $_) foreach @{ $errors };
96 return $self->js->render();
99 flash_later('info', $::locale->text('The order has been saved'));
100 my @redirect_params = (
103 id => $self->order->id,
106 $self->redirect_to(@redirect_params);
109 sub action_create_pdf {
113 my @errors = _create_pdf($self->order, \$pdf);
114 if (scalar @errors) {
115 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
118 my $sfile = SL::SessionFile::Random->new(mode => "w");
119 $sfile->fh->print($pdf);
122 my $tmp_filename = $sfile->file_name;
123 my $pdf_filename = t8('Sales Order') . '_' . $self->order->ordnumber . '.pdf';
126 ->run('download_pdf', $tmp_filename, $pdf_filename)
127 ->flash('info', t8('The PDF has been created'))->render($self);
130 sub action_download_pdf {
133 return $self->send_file(
134 $::form->{tmp_filename},
135 type => 'application/pdf',
136 name => $::form->{pdf_filename},
140 sub action_show_email_dialog {
143 my $cv_method = $self->cv;
145 if (!$self->order->$cv_method) {
146 return $self->js->flash('error', t8('Cannot send E-mail without ' . $self->cv))
150 $self->{email}->{to} = $self->order->contact->cp_email if $self->order->contact;
151 $self->{email}->{to} ||= $self->order->$cv_method->email;
152 $self->{email}->{cc} = $self->order->$cv_method->cc;
153 $self->{email}->{bcc} = join ', ', grep $_, $self->order->$cv_method->bcc, SL::DB::Default->get->global_bcc;
154 # Todo: get addresses from shipto, if any
156 my $form = Form->new;
157 $form->{ordnumber} = $self->order->ordnumber;
158 $form->{formname} = $self->type;
159 $form->{type} = $self->type;
160 $form->{language} = 'de';
161 $form->{format} = 'pdf';
163 $self->{email}->{subject} = $form->generate_email_subject();
164 $self->{email}->{attachment_filename} = $form->generate_attachment_filename();
165 $self->{email}->{message} = $form->create_email_signature();
167 my $dialog_html = $self->render('order/tabs/_email_dialog', { output => 0 });
169 ->run('show_email_dialog', $dialog_html)
174 # Todo: handling error messages: flash is not displayed in dialog, but in the main form
175 sub action_send_email {
178 my $mail = Mailer->new;
179 $mail->{from} = qq|"$::myconfig{name}" <$::myconfig{email}>|;
180 $mail->{$_} = $::form->{email}->{$_} for qw(to cc bcc subject message);
183 my @errors = _create_pdf($self->order, \$pdf, {media => 'email'});
184 if (scalar @errors) {
185 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
188 $mail->{attachments} = [{ "content" => $pdf,
189 "name" => $::form->{email}->{attachment_filename} }];
191 if (my $err = $mail->send) {
192 return $self->js->flash('error', t8('Sending E-mail: ') . $err)
197 my $intnotes = $self->order->intnotes;
198 $intnotes .= "\n\n" if $self->order->intnotes;
199 $intnotes .= t8('[email]') . "\n";
200 $intnotes .= t8('Date') . ": " . $::locale->format_date_object(DateTime->now_local, precision => 'seconds') . "\n";
201 $intnotes .= t8('To (email)') . ": " . $mail->{to} . "\n";
202 $intnotes .= t8('Cc') . ": " . $mail->{cc} . "\n" if $mail->{cc};
203 $intnotes .= t8('Bcc') . ": " . $mail->{bcc} . "\n" if $mail->{bcc};
204 $intnotes .= t8('Subject') . ": " . $mail->{subject} . "\n\n";
205 $intnotes .= t8('Message') . ": " . $mail->{message};
208 ->val('#order_intnotes', $intnotes)
209 ->run('close_email_dialog')
213 sub action_save_and_delivery_order {
216 my $errors = $self->_save();
218 if (scalar @{ $errors }) {
219 $self->js->flash('error', $_) foreach @{ $errors };
220 return $self->js->render();
223 my $delivery_order = $self->order->convert_to_delivery_order($self->order);
225 flash_later('info', $::locale->text('The order has been saved'));
226 my @redirect_params = (
227 controller => 'do.pl',
229 type => $delivery_order->type,
230 id => $delivery_order->id,
231 vc => $delivery_order->is_sales ? 'customer' : 'vendor',
234 $self->redirect_to(@redirect_params);
237 sub action_customer_vendor_changed {
240 if ($self->cv eq 'customer') {
241 $self->order->customer(SL::DB::Manager::Customer->find_by_or_create(id => $::form->{cv_id}));
243 } elsif ($self->cv eq 'vendor') {
244 $self->order->vendor(SL::DB::Manager::Vendor->find_by_or_create(id => $::form->{cv_id}));
247 if ($self->order->{$self->cv}->contacts && scalar @{ $self->order->{$self->cv}->contacts } > 0) {
248 $self->js->show('#cp_row');
250 $self->js->hide('#cp_row');
253 if ($self->order->{$self->cv}->shipto && scalar @{ $self->order->{$self->cv}->shipto } > 0) {
254 $self->js->show('#shipto_row');
256 $self->js->hide('#shipto_row');
260 ->replaceWith('#order_cp_id', $self->build_contact_select)
261 ->replaceWith('#order_shipto_id', $self->build_shipto_select)
262 ->val('#order_taxzone_id', $self->order->{$self->cv}->taxzone_id)
263 ->focus('#order_' . $self->cv . '_id')
267 sub action_add_item {
270 my $form_attr = $::form->{add_item};
272 return unless $form_attr->{parts_id};
274 my $item = SL::DB::OrderItem->new;
275 $item->assign_attributes(%$form_attr);
277 my $part = SL::DB::Part->new(id => $form_attr->{parts_id})->load;
278 my $cv_method = $self->cv;
279 my $cv_discount = $self->order->$cv_method? $self->order->$cv_method->discount : 0.0;
282 $new_attr{part} = $part;
283 $new_attr{description} = $part->description if ! $item->description;
284 $new_attr{qty} = 1.0 if ! $item->qty;
285 $new_attr{unit} = $part->unit;
286 $new_attr{sellprice} = $part->sellprice if ! $item->sellprice;
287 $new_attr{discount} = $cv_discount if ! $item->discount;
289 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
290 # they cannot be retrieved via custom_variables until the order/orderitem is
291 # saved. Adding empty custom_variables to new orderitem here solves this problem.
292 $new_attr{custom_variables} = [];
294 $item->assign_attributes(%new_attr);
296 $self->order->add_items($item);
300 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
301 my $row_as_html = $self->p->render('order/tabs/_row', ITEM => $item, ID => $item_id);
304 ->append('#row_table_id', $row_as_html)
305 ->val('#add_item_parts_id', '')
306 ->val('#add_item_parts_id_name', '')
307 ->val('#add_item_description', '')
308 ->val('#add_item_qty_as_number', '')
309 ->val('#add_item_sellprice_as_number', '')
310 ->val('#add_item_discount_as_percent', '')
311 ->run('row_table_scroll_down')
312 ->run('row_set_keyboard_events_by_id', $item_id)
313 ->on('.recalc', 'change', 'recalc_amounts_and_taxes')
314 ->focus('#add_item_parts_id_name');
316 $self->_js_redisplay_amounts_and_taxes;
320 sub action_recalc_amounts_and_taxes {
325 $self->_js_redisplay_linetotals;
326 $self->_js_redisplay_amounts_and_taxes;
330 sub _js_redisplay_linetotals {
333 my @data = map {$::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0)} @{ $self->order->items };
335 ->run('redisplay_linetotals', \@data);
338 sub _js_redisplay_amounts_and_taxes {
341 if (scalar @{ $self->{taxes} }) {
342 $self->js->show('#taxincluded_row_id');
344 $self->js->hide('#taxincluded_row_id');
347 if ($self->order->taxincluded) {
348 $self->js->hide('#subtotal_row_id');
350 $self->js->show('#subtotal_row_id');
354 ->html('#netamount_id', $::form->format_amount(\%::myconfig, $self->order->netamount, -2))
355 ->html('#amount_id', $::form->format_amount(\%::myconfig, $self->order->amount, -2))
357 ->insertBefore($self->build_tax_rows, '#amount_row_id');
364 sub init_valid_types {
365 [ _sales_order_type(), _purchase_order_type() ];
371 if (none { $::form->{type} eq $_ } @{$self->valid_types}) {
372 die "Not a valid type for order";
375 $self->type($::form->{type});
381 my $cv = $self->type eq _sales_order_type() ? 'customer'
382 : $self->type eq _purchase_order_type() ? 'vendor'
383 : die "Not a valid type for order";
399 my $right_for = { map { $_ => $_.'_edit' } @{$self->valid_types} };
401 my $right = $right_for->{ $self->type };
402 $right ||= 'DOES_NOT_EXIST';
404 $::auth->assert($right);
407 sub build_contact_select {
410 $self->p->select_tag('order.cp_id', [ $self->order->{$self->cv}->contacts ],
411 value_key => 'cp_id',
412 title_key => 'full_name_dep',
413 default => $self->order->cp_id,
415 style => 'width: 300px',
419 sub build_shipto_select {
422 $self->p->select_tag('order.shipto_id', [ $self->order->{$self->cv}->shipto ],
423 value_key => 'shipto_id',
424 title_key => 'displayable_id',
425 default => $self->order->shipto_id,
427 style => 'width: 300px',
435 foreach my $tax (@{ $self->{taxes} }) {
436 $rows_as_html .= $self->p->render('order/tabs/_tax_row', TAX => $tax, TAXINCLUDED => $self->order->taxincluded);
438 return $rows_as_html;
445 # add_items adds items to an order with no items for saving, but they cannot
446 # be retrieved via items until the order is saved. Adding empty items to new
447 # order here solves this problem.
449 $order = SL::DB::Manager::Order->find_by(id => $::form->{id}) if $::form->{id};
450 $order ||= SL::DB::Order->new(orderitems => []);
452 $order->assign_attributes(%{$::form->{order}});
461 # bb: todo: currency later
462 $self->order->currency_id($::instance_conf->get_currency_id());
464 my %pat = $self->order->calculate_prices_and_taxes();
466 foreach my $tax_chart_id (keys %{ $pat{taxes} }) {
467 my $tax = SL::DB::Manager::Tax->find_by(chart_id => $tax_chart_id);
469 my @amount_keys = grep { $pat{amounts}->{$_}->{tax_id} == $tax->id } keys %{ $pat{amounts} };
470 push(@{ $self->{taxes} }, { amount => $pat{taxes}->{$tax_chart_id},
471 netamount => $pat{amounts}->{$amount_keys[0]}->{amount},
475 pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items}, @{$pat{items}};
479 sub _get_unalterable_data {
482 foreach my $item (@{ $self->order->items }) {
484 # load data from orderitems (db)
485 my $db_item = SL::DB::OrderItem->new(id => $item->id)->load;
486 $item->$_($db_item->$_) for qw(active_discount_source active_price_source longdescription);
488 # set data from part (or other sources)
489 $item->longdescription($item->part->notes);
490 #$item->active_price_source('');
491 #$item->active_discount_source('');
494 # autovivify all cvars that are not in the form (cvars_by_config can do it).
495 $item->cvars_by_config;
496 $item->parse_custom_variable_values;
505 my $db = $self->order->db;
509 $self->order->save();
510 }) || push(@{$errors}, $db->error);
519 $self->{all_taxzones} = SL::DB::Manager::TaxZone->get_all_sorted();
520 $self->{all_employees} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->employee_id,
523 $self->{all_salesmen} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->salesman_id,
526 $self->{all_projects} = SL::DB::Manager::Project->get_all(where => [ or => [ id => $self->order->globalproject_id,
528 sort_by => 'projectnumber');
529 $self->{all_payment_terms} = SL::DB::Manager::PaymentTerm->get_all_sorted();
530 $self->{all_delivery_terms} = SL::DB::Manager::DeliveryTerm->get_all_sorted();
532 $self->{current_employee_id} = SL::DB::Manager::Employee->current->id;
534 $::request->{layout}->use_javascript("${_}.js") for qw(ckeditor/ckeditor ckeditor/adapters/jquery);
538 my ($order, $pdf_ref, $params) = @_;
540 my $print_form = Form->new('');
541 $print_form->{type} = 'sales_order';
542 $print_form->{formname} = 'sales_order',
543 $print_form->{format} = $params->{format} || 'pdf',
544 $print_form->{media} = $params->{media} || 'file';
546 $order->flatten_to_form($print_form, format_amounts => 1);
547 # flatten_to_form sets payment_terms from customer/vendor - we do not want that here
548 delete $print_form->{payment_terms} if !$print_form->{payment_id};
551 $print_form->throw_on_error(sub {
553 $print_form->prepare_for_printing;
555 $$pdf_ref = SL::Helper::CreatePDF->create_pdf(
556 template => SL::Helper::CreatePDF->find_template(name => $print_form->{formname}),
557 variables => $print_form,
558 variable_content_types => {
559 longdescription => 'html',
565 } || push @errors, ref($EVAL_ERROR) eq 'SL::X::FormError' ? $EVAL_ERROR->getMessage : $EVAL_ERROR;
571 sub _sales_order_type {
575 sub _purchase_order_type {
587 SL::Controller::Order - controller for orders
591 Testing, PriceSources, pricefactor, units, currency, delivered, delivery order created, ...
595 Bernd Bleßmann E<lt>bernd@kivitendo-premium.deE<gt>