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);
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 my $pdf_filename = t8('Sales Order') . '_' . $self->order->ordnumber . '.pdf';
130 ->run('download_pdf', $pdf_filename, $key)
131 ->flash('info', t8('The PDF has been created'))->render($self);
134 sub action_download_pdf {
137 my $key = $::form->{key};
138 my $tmp_filename = $::auth->get_session_value("Order::create_pdf-${key}");
139 return $self->send_file(
141 type => 'application/pdf',
142 name => $::form->{pdf_filename},
146 sub action_show_email_dialog {
149 my $cv_method = $self->cv;
151 if (!$self->order->$cv_method) {
152 return $self->js->flash('error', t8('Cannot send E-mail without ' . $self->cv))
156 $self->{email}->{to} = $self->order->contact->cp_email if $self->order->contact;
157 $self->{email}->{to} ||= $self->order->$cv_method->email;
158 $self->{email}->{cc} = $self->order->$cv_method->cc;
159 $self->{email}->{bcc} = join ', ', grep $_, $self->order->$cv_method->bcc, SL::DB::Default->get->global_bcc;
160 # Todo: get addresses from shipto, if any
162 my $form = Form->new;
163 $form->{ordnumber} = $self->order->ordnumber;
164 $form->{formname} = $self->type;
165 $form->{type} = $self->type;
166 $form->{language} = 'de';
167 $form->{format} = 'pdf';
169 $self->{email}->{subject} = $form->generate_email_subject();
170 $self->{email}->{attachment_filename} = $form->generate_attachment_filename();
171 $self->{email}->{message} = $form->create_email_signature();
173 my $dialog_html = $self->render('order/tabs/_email_dialog', { output => 0 });
175 ->run('show_email_dialog', $dialog_html)
180 # Todo: handling error messages: flash is not displayed in dialog, but in the main form
181 sub action_send_email {
184 my $mail = Mailer->new;
185 $mail->{from} = qq|"$::myconfig{name}" <$::myconfig{email}>|;
186 $mail->{$_} = $::form->{email}->{$_} for qw(to cc bcc subject message);
189 my @errors = _create_pdf($self->order, \$pdf, {media => 'email'});
190 if (scalar @errors) {
191 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
194 $mail->{attachments} = [{ "content" => $pdf,
195 "name" => $::form->{email}->{attachment_filename} }];
197 if (my $err = $mail->send) {
198 return $self->js->flash('error', t8('Sending E-mail: ') . $err)
203 my $intnotes = $self->order->intnotes;
204 $intnotes .= "\n\n" if $self->order->intnotes;
205 $intnotes .= t8('[email]') . "\n";
206 $intnotes .= t8('Date') . ": " . $::locale->format_date_object(DateTime->now_local, precision => 'seconds') . "\n";
207 $intnotes .= t8('To (email)') . ": " . $mail->{to} . "\n";
208 $intnotes .= t8('Cc') . ": " . $mail->{cc} . "\n" if $mail->{cc};
209 $intnotes .= t8('Bcc') . ": " . $mail->{bcc} . "\n" if $mail->{bcc};
210 $intnotes .= t8('Subject') . ": " . $mail->{subject} . "\n\n";
211 $intnotes .= t8('Message') . ": " . $mail->{message};
214 ->val('#order_intnotes', $intnotes)
215 ->run('close_email_dialog')
219 sub action_save_and_delivery_order {
222 my $errors = $self->_save();
224 if (scalar @{ $errors }) {
225 $self->js->flash('error', $_) foreach @{ $errors };
226 return $self->js->render();
229 my $delivery_order = $self->order->convert_to_delivery_order($self->order);
231 flash_later('info', $::locale->text('The order has been saved'));
232 my @redirect_params = (
233 controller => 'do.pl',
235 type => $delivery_order->type,
236 id => $delivery_order->id,
237 vc => $delivery_order->is_sales ? 'customer' : 'vendor',
240 $self->redirect_to(@redirect_params);
243 sub action_customer_vendor_changed {
246 if ($self->cv eq 'customer') {
247 $self->order->customer(SL::DB::Manager::Customer->find_by_or_create(id => $::form->{cv_id}));
249 } elsif ($self->cv eq 'vendor') {
250 $self->order->vendor(SL::DB::Manager::Vendor->find_by_or_create(id => $::form->{cv_id}));
253 if ($self->order->{$self->cv}->contacts && scalar @{ $self->order->{$self->cv}->contacts } > 0) {
254 $self->js->show('#cp_row');
256 $self->js->hide('#cp_row');
259 if ($self->order->{$self->cv}->shipto && scalar @{ $self->order->{$self->cv}->shipto } > 0) {
260 $self->js->show('#shipto_row');
262 $self->js->hide('#shipto_row');
266 ->replaceWith('#order_cp_id', $self->build_contact_select)
267 ->replaceWith('#order_shipto_id', $self->build_shipto_select)
268 ->val('#order_taxzone_id', $self->order->{$self->cv}->taxzone_id)
269 ->focus('#order_' . $self->cv . '_id')
273 sub action_add_item {
276 my $form_attr = $::form->{add_item};
278 return unless $form_attr->{parts_id};
280 my $item = SL::DB::OrderItem->new;
281 $item->assign_attributes(%$form_attr);
283 my $part = SL::DB::Part->new(id => $form_attr->{parts_id})->load;
284 my $cv_method = $self->cv;
285 my $cv_discount = $self->order->$cv_method? $self->order->$cv_method->discount : 0.0;
287 my $price = $item->sellprice;
288 $price ||= ($self->order->$cv_method && $self->order->$cv_method->klass)
289 ? (SL::DB::Manager::Price->find_by(parts_id => $part->id, pricegroup_id => $self->order->$cv_method->klass)->price || $part->sellprice)
293 $new_attr{part} = $part;
294 $new_attr{description} = $part->description if ! $item->description;
295 $new_attr{qty} = 1.0 if ! $item->qty;
296 $new_attr{unit} = $part->unit;
297 $new_attr{sellprice} = $price;
298 $new_attr{discount} = $cv_discount if ! $item->discount;
300 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
301 # they cannot be retrieved via custom_variables until the order/orderitem is
302 # saved. Adding empty custom_variables to new orderitem here solves this problem.
303 $new_attr{custom_variables} = [];
305 $item->assign_attributes(%new_attr);
307 $self->order->add_items($item);
311 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
312 my $row_as_html = $self->p->render('order/tabs/_row', ITEM => $item, ID => $item_id);
315 ->append('#row_table_id', $row_as_html)
316 ->val('#add_item_parts_id', '')
317 ->val('#add_item_parts_id_name', '')
318 ->val('#add_item_description', '')
319 ->val('#add_item_qty_as_number', '')
320 ->val('#add_item_sellprice_as_number', '')
321 ->val('#add_item_discount_as_percent', '')
322 ->run('row_table_scroll_down')
323 ->run('row_set_keyboard_events_by_id', $item_id)
324 ->on('.recalc', 'change', 'recalc_amounts_and_taxes')
325 ->focus('#add_item_parts_id_name');
327 $self->_js_redisplay_amounts_and_taxes;
331 sub action_recalc_amounts_and_taxes {
336 $self->_js_redisplay_linetotals;
337 $self->_js_redisplay_amounts_and_taxes;
341 sub _js_redisplay_linetotals {
344 my @data = map {$::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0)} @{ $self->order->items };
346 ->run('redisplay_linetotals', \@data);
349 sub _js_redisplay_amounts_and_taxes {
352 if (scalar @{ $self->{taxes} }) {
353 $self->js->show('#taxincluded_row_id');
355 $self->js->hide('#taxincluded_row_id');
358 if ($self->order->taxincluded) {
359 $self->js->hide('#subtotal_row_id');
361 $self->js->show('#subtotal_row_id');
365 ->html('#netamount_id', $::form->format_amount(\%::myconfig, $self->order->netamount, -2))
366 ->html('#amount_id', $::form->format_amount(\%::myconfig, $self->order->amount, -2))
368 ->insertBefore($self->build_tax_rows, '#amount_row_id');
375 sub init_valid_types {
376 [ _sales_order_type(), _purchase_order_type() ];
382 if (none { $::form->{type} eq $_ } @{$self->valid_types}) {
383 die "Not a valid type for order";
386 $self->type($::form->{type});
392 my $cv = $self->type eq _sales_order_type() ? 'customer'
393 : $self->type eq _purchase_order_type() ? 'vendor'
394 : die "Not a valid type for order";
410 my $right_for = { map { $_ => $_.'_edit' } @{$self->valid_types} };
412 my $right = $right_for->{ $self->type };
413 $right ||= 'DOES_NOT_EXIST';
415 $::auth->assert($right);
418 sub build_contact_select {
421 $self->p->select_tag('order.cp_id', [ $self->order->{$self->cv}->contacts ],
422 value_key => 'cp_id',
423 title_key => 'full_name_dep',
424 default => $self->order->cp_id,
426 style => 'width: 300px',
430 sub build_shipto_select {
433 $self->p->select_tag('order.shipto_id', [ $self->order->{$self->cv}->shipto ],
434 value_key => 'shipto_id',
435 title_key => 'displayable_id',
436 default => $self->order->shipto_id,
438 style => 'width: 300px',
446 foreach my $tax (@{ $self->{taxes} }) {
447 $rows_as_html .= $self->p->render('order/tabs/_tax_row', TAX => $tax, TAXINCLUDED => $self->order->taxincluded);
449 return $rows_as_html;
456 # add_items adds items to an order with no items for saving, but they cannot
457 # be retrieved via items until the order is saved. Adding empty items to new
458 # order here solves this problem.
460 $order = SL::DB::Manager::Order->find_by(id => $::form->{id}) if $::form->{id};
461 $order ||= SL::DB::Order->new(orderitems => []);
463 $order->assign_attributes(%{$::form->{order}});
472 # bb: todo: currency later
473 $self->order->currency_id($::instance_conf->get_currency_id());
475 my %pat = $self->order->calculate_prices_and_taxes();
477 foreach my $tax_chart_id (keys %{ $pat{taxes} }) {
478 my $tax = SL::DB::Manager::Tax->find_by(chart_id => $tax_chart_id);
480 my @amount_keys = grep { $pat{amounts}->{$_}->{tax_id} == $tax->id } keys %{ $pat{amounts} };
481 push(@{ $self->{taxes} }, { amount => $pat{taxes}->{$tax_chart_id},
482 netamount => $pat{amounts}->{$amount_keys[0]}->{amount},
486 pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items}, @{$pat{items}};
490 sub _get_unalterable_data {
493 foreach my $item (@{ $self->order->items }) {
495 # load data from orderitems (db)
496 my $db_item = SL::DB::OrderItem->new(id => $item->id)->load;
497 $item->$_($db_item->$_) for qw(active_discount_source active_price_source longdescription);
499 # set data from part (or other sources)
500 $item->longdescription($item->part->notes);
501 #$item->active_price_source('');
502 #$item->active_discount_source('');
505 # autovivify all cvars that are not in the form (cvars_by_config can do it).
506 # workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
507 foreach my $var (@{ $item->cvars_by_config }) {
508 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
510 $item->parse_custom_variable_values;
519 my $db = $self->order->db;
523 $self->order->save();
524 }) || push(@{$errors}, $db->error);
533 $self->{all_taxzones} = SL::DB::Manager::TaxZone->get_all_sorted();
534 $self->{all_employees} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->employee_id,
537 $self->{all_salesmen} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->salesman_id,
540 $self->{all_projects} = SL::DB::Manager::Project->get_all(where => [ or => [ id => $self->order->globalproject_id,
542 sort_by => 'projectnumber');
543 $self->{all_payment_terms} = SL::DB::Manager::PaymentTerm->get_all_sorted();
544 $self->{all_delivery_terms} = SL::DB::Manager::DeliveryTerm->get_all_sorted();
546 $self->{current_employee_id} = SL::DB::Manager::Employee->current->id;
548 $::request->{layout}->use_javascript("${_}.js") for qw(ckeditor/ckeditor ckeditor/adapters/jquery);
552 my ($order, $pdf_ref, $params) = @_;
554 my $print_form = Form->new('');
555 $print_form->{type} = 'sales_order';
556 $print_form->{formname} = 'sales_order',
557 $print_form->{format} = $params->{format} || 'pdf',
558 $print_form->{media} = $params->{media} || 'file';
560 $order->flatten_to_form($print_form, format_amounts => 1);
561 # flatten_to_form sets payment_terms from customer/vendor - we do not want that here
562 delete $print_form->{payment_terms} if !$print_form->{payment_id};
565 $print_form->throw_on_error(sub {
567 $print_form->prepare_for_printing;
569 $$pdf_ref = SL::Helper::CreatePDF->create_pdf(
570 template => SL::Helper::CreatePDF->find_template(name => $print_form->{formname}),
571 variables => $print_form,
572 variable_content_types => {
573 longdescription => 'html',
579 } || push @errors, ref($EVAL_ERROR) eq 'SL::X::FormError' ? $EVAL_ERROR->getMessage : $EVAL_ERROR;
585 sub _sales_order_type {
589 sub _purchase_order_type {
601 SL::Controller::Order - controller for orders
605 Testing, PriceSources, pricefactor, units, currency, delivered, delivery order created, ...
609 Bernd Bleßmann E<lt>bernd@kivitendo-premium.deE<gt>