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->_save();
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 saved'));
104 my @redirect_params = (
107 id => $self->order->id,
110 $self->redirect_to(@redirect_params);
113 sub action_create_pdf {
117 my @errors = _create_pdf($self->order, \$pdf);
118 if (scalar @errors) {
119 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
122 my $sfile = SL::SessionFile::Random->new(mode => "w");
123 $sfile->fh->print($pdf);
126 my $key = join('_', Time::HiRes::gettimeofday(), int rand 1000000000000);
127 $::auth->set_session_value("Order::create_pdf-${key}" => $sfile->file_name);
129 my $form = Form->new;
130 $form->{ordnumber} = $self->order->ordnumber;
131 $form->{formname} = $self->type;
132 $form->{type} = $self->type;
133 $form->{language} = 'de';
134 $form->{format} = 'pdf';
136 my $pdf_filename = $form->generate_attachment_filename();
138 # copy file to webdav folder
139 if ($self->order->ordnumber && $::instance_conf->get_webdav_documents) {
140 my $webdav = SL::Webdav->new(
142 number => $self->order->ordnumber,
144 my $webdav_file = SL::Webdav::File->new(
146 filename => $pdf_filename,
149 $webdav_file->store(data => \$pdf);
152 $self->js->flash('error', t8('Storing PDF to webdav folder failed: #1', $@));
157 ->run('download_pdf', $pdf_filename, $key)
158 ->flash('info', t8('The PDF has been created'))->render($self);
161 sub action_download_pdf {
164 my $key = $::form->{key};
165 my $tmp_filename = $::auth->get_session_value("Order::create_pdf-${key}");
166 return $self->send_file(
168 type => 'application/pdf',
169 name => $::form->{pdf_filename},
173 sub action_show_email_dialog {
176 my $cv_method = $self->cv;
178 if (!$self->order->$cv_method) {
179 return $self->js->flash('error', t8('Cannot send E-mail without ' . $self->cv))
183 $self->{email}->{to} = $self->order->contact->cp_email if $self->order->contact;
184 $self->{email}->{to} ||= $self->order->$cv_method->email;
185 $self->{email}->{cc} = $self->order->$cv_method->cc;
186 $self->{email}->{bcc} = join ', ', grep $_, $self->order->$cv_method->bcc, SL::DB::Default->get->global_bcc;
187 # Todo: get addresses from shipto, if any
189 my $form = Form->new;
190 $form->{ordnumber} = $self->order->ordnumber;
191 $form->{formname} = $self->type;
192 $form->{type} = $self->type;
193 $form->{language} = 'de';
194 $form->{format} = 'pdf';
196 $self->{email}->{subject} = $form->generate_email_subject();
197 $self->{email}->{attachment_filename} = $form->generate_attachment_filename();
198 $self->{email}->{message} = $form->create_email_signature();
200 my $dialog_html = $self->render('order/tabs/_email_dialog', { output => 0 });
202 ->run('show_email_dialog', $dialog_html)
207 # Todo: handling error messages: flash is not displayed in dialog, but in the main form
208 sub action_send_email {
211 my $mail = Mailer->new;
212 $mail->{from} = qq|"$::myconfig{name}" <$::myconfig{email}>|;
213 $mail->{$_} = $::form->{email}->{$_} for qw(to cc bcc subject message);
216 my @errors = _create_pdf($self->order, \$pdf, {media => 'email'});
217 if (scalar @errors) {
218 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
221 $mail->{attachments} = [{ "content" => $pdf,
222 "name" => $::form->{email}->{attachment_filename} }];
224 if (my $err = $mail->send) {
225 return $self->js->flash('error', t8('Sending E-mail: ') . $err)
230 my $intnotes = $self->order->intnotes;
231 $intnotes .= "\n\n" if $self->order->intnotes;
232 $intnotes .= t8('[email]') . "\n";
233 $intnotes .= t8('Date') . ": " . $::locale->format_date_object(DateTime->now_local, precision => 'seconds') . "\n";
234 $intnotes .= t8('To (email)') . ": " . $mail->{to} . "\n";
235 $intnotes .= t8('Cc') . ": " . $mail->{cc} . "\n" if $mail->{cc};
236 $intnotes .= t8('Bcc') . ": " . $mail->{bcc} . "\n" if $mail->{bcc};
237 $intnotes .= t8('Subject') . ": " . $mail->{subject} . "\n\n";
238 $intnotes .= t8('Message') . ": " . $mail->{message};
241 ->val('#order_intnotes', $intnotes)
242 ->run('close_email_dialog')
246 sub action_save_and_delivery_order {
249 my $errors = $self->_save();
251 if (scalar @{ $errors }) {
252 $self->js->flash('error', $_) foreach @{ $errors };
253 return $self->js->render();
256 my $delivery_order = $self->order->convert_to_delivery_order($self->order);
258 flash_later('info', $::locale->text('The order has been saved'));
259 my @redirect_params = (
260 controller => 'do.pl',
262 type => $delivery_order->type,
263 id => $delivery_order->id,
264 vc => $delivery_order->is_sales ? 'customer' : 'vendor',
267 $self->redirect_to(@redirect_params);
270 sub action_customer_vendor_changed {
273 my $cv_method = $self->cv;
275 if ($self->order->$cv_method->contacts && scalar @{ $self->order->$cv_method->contacts } > 0) {
276 $self->js->show('#cp_row');
278 $self->js->hide('#cp_row');
281 if ($self->order->$cv_method->shipto && scalar @{ $self->order->$cv_method->shipto } > 0) {
282 $self->js->show('#shipto_row');
284 $self->js->hide('#shipto_row');
287 $self->order->taxzone_id($self->order->$cv_method->taxzone_id);
289 if ($self->order->is_sales) {
290 $self->order->taxincluded(defined($self->order->$cv_method->taxincluded_checked)
291 ? $self->order->$cv_method->taxincluded_checked
292 : $::myconfig{taxincluded_checked});
298 ->replaceWith('#order_cp_id', $self->build_contact_select)
299 ->replaceWith('#order_shipto_id', $self->build_shipto_select)
300 ->val( '#order_taxzone_id', $self->order->taxzone_id)
301 ->val( '#order_taxincluded', $self->order->taxincluded)
302 ->focus( '#order_' . $self->cv . '_id');
304 $self->_js_redisplay_amounts_and_taxes;
308 sub action_add_item {
311 my $form_attr = $::form->{add_item};
313 return unless $form_attr->{parts_id};
315 my $item = _make_item($self->order, $form_attr);
316 $self->order->add_items($item);
320 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
321 my $row_as_html = $self->p->render('order/tabs/_row', ITEM => $item, ID => $item_id);
324 ->append('#row_table_id', $row_as_html)
325 ->val('#add_item_parts_id', '')
326 ->val('#add_item_parts_id_name', '')
327 ->val('#add_item_description', '')
328 ->val('#add_item_qty_as_number', '')
329 ->val('#add_item_sellprice_as_number', '')
330 ->val('#add_item_discount_as_percent', '')
331 ->run('row_table_scroll_down')
332 ->run('row_set_keyboard_events_by_id', $item_id)
333 ->on('.recalc', 'change', 'recalc_amounts_and_taxes')
334 ->on('.reformat_number', 'change', 'reformat_number')
335 ->focus('#add_item_parts_id_name');
337 $self->_js_redisplay_amounts_and_taxes;
341 sub action_show_multi_items_dialog {
344 $self->{multi_items}->{parts} = SL::DB::Manager::Part->get_all_sorted(where => [ obsolete => 0 ]);
345 my $dialog_html = $self->render('order/tabs/_multi_items_dialog', { output => 0 });
348 ->run('show_multi_items_dialog', $dialog_html, t8('Add multiple parts'))
353 sub action_add_multi_items {
356 my @form_attr = grep { $_->{qty} } @{ $::form->{add_multi_items} };
357 return unless scalar @form_attr;
360 foreach my $attr (@form_attr) {
361 push @items, _make_item($self->order, $attr);
363 $self->order->add_items(@items);
367 foreach my $item (@items) {
368 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
369 my $row_as_html = $self->p->render('order/tabs/_row', ITEM => $item, ID => $item_id);
372 ->append('#row_table_id', $row_as_html)
373 ->run('row_set_keyboard_events_by_id', $item_id);
377 ->run('close_multi_items_dialog')
378 ->run('row_table_scroll_down')
379 ->on('.recalc', 'change', 'recalc_amounts_and_taxes')
380 ->on('.reformat_number', 'change', 'reformat_number')
381 ->focus('#add_item_parts_id_name');
383 $self->_js_redisplay_amounts_and_taxes;
387 sub action_recalc_amounts_and_taxes {
392 $self->_js_redisplay_linetotals;
393 $self->_js_redisplay_amounts_and_taxes;
397 sub action_price_popup {
400 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
401 my $item = $self->order->items->[$idx];
403 $self->render_price_dialog($item);
406 sub _js_redisplay_linetotals {
409 my @data = map {$::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0)} @{ $self->order->items };
411 ->run('redisplay_linetotals', \@data);
414 sub _js_redisplay_amounts_and_taxes {
417 if (scalar @{ $self->{taxes} }) {
418 $self->js->show('#taxincluded_row_id');
420 $self->js->hide('#taxincluded_row_id');
423 if ($self->order->taxincluded) {
424 $self->js->hide('#subtotal_row_id');
426 $self->js->show('#subtotal_row_id');
430 ->html('#netamount_id', $::form->format_amount(\%::myconfig, $self->order->netamount, -2))
431 ->html('#amount_id', $::form->format_amount(\%::myconfig, $self->order->amount, -2))
433 ->insertBefore($self->build_tax_rows, '#amount_row_id');
440 sub init_valid_types {
441 [ _sales_order_type(), _purchase_order_type() ];
447 if (none { $::form->{type} eq $_ } @{$self->valid_types}) {
448 die "Not a valid type for order";
451 $self->type($::form->{type});
457 my $cv = $self->type eq _sales_order_type() ? 'customer'
458 : $self->type eq _purchase_order_type() ? 'vendor'
459 : die "Not a valid type for order";
475 my $right_for = { map { $_ => $_.'_edit' } @{$self->valid_types} };
477 my $right = $right_for->{ $self->type };
478 $right ||= 'DOES_NOT_EXIST';
480 $::auth->assert($right);
483 sub build_contact_select {
486 $self->p->select_tag('order.cp_id', [ $self->order->{$self->cv}->contacts ],
487 value_key => 'cp_id',
488 title_key => 'full_name_dep',
489 default => $self->order->cp_id,
491 style => 'width: 300px',
495 sub build_shipto_select {
498 $self->p->select_tag('order.shipto_id', [ $self->order->{$self->cv}->shipto ],
499 value_key => 'shipto_id',
500 title_key => 'displayable_id',
501 default => $self->order->shipto_id,
503 style => 'width: 300px',
511 foreach my $tax (sort { $a->{tax}->rate cmp $b->{tax}->rate } @{ $self->{taxes} }) {
512 $rows_as_html .= $self->p->render('order/tabs/_tax_row', TAX => $tax, TAXINCLUDED => $self->order->taxincluded);
514 return $rows_as_html;
518 sub render_price_dialog {
519 my ($self, $record_item) = @_;
521 my $price_source = SL::PriceSource->new(record_item => $record_item, record => $self->order);
525 'kivi.io.price_chooser_dialog',
526 t8('Available Prices'),
527 $self->render('order/tabs/_price_sources_dialog', { output => 0 }, price_source => $price_source)
532 # $self->js->text('#dialog_flash_error_content', join ' ', @errors);
533 # $self->js->show('#dialog_flash_error');
542 # add_items adds items to an order with no items for saving, but they cannot
543 # be retrieved via items until the order is saved. Adding empty items to new
544 # order here solves this problem.
546 $order = SL::DB::Manager::Order->find_by(id => $::form->{id}) if $::form->{id};
547 $order ||= SL::DB::Order->new(orderitems => []);
549 $order->assign_attributes(%{$::form->{order}});
555 my ($record, $attr) = @_;
557 my $item = SL::DB::OrderItem->new;
558 $item->assign_attributes(%$attr);
560 my $part = SL::DB::Part->new(id => $attr->{parts_id})->load;
561 my $price_source = SL::PriceSource->new(record_item => $item, record => $record);
563 $item->unit($part->unit) if !$item->unit;
566 if ($item->sellprice) {
567 $price_src = $price_source->price_from_source("");
568 $price_src->price($item->sellprice);
570 $price_src = $price_source->best_price
571 ? $price_source->best_price
572 : $price_source->price_from_source("");
573 $price_src->price(0) if !$price_source->best_price;
577 if ($item->discount) {
578 $discount_src = $price_source->discount_from_source("");
579 $discount_src->discount($item->discount);
581 $discount_src = $price_source->best_discount
582 ? $price_source->best_discount
583 : $price_source->discount_from_source("");
584 $discount_src->discount(0) if !$price_source->best_discount;
588 $new_attr{part} = $part;
589 $new_attr{description} = $part->description if ! $item->description;
590 $new_attr{qty} = 1.0 if ! $item->qty;
591 $new_attr{sellprice} = $price_src->price;
592 $new_attr{discount} = $discount_src->discount;
593 $new_attr{active_price_source} = $price_src;
594 $new_attr{active_discount_source} = $discount_src;
596 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
597 # they cannot be retrieved via custom_variables until the order/orderitem is
598 # saved. Adding empty custom_variables to new orderitem here solves this problem.
599 $new_attr{custom_variables} = [];
601 $item->assign_attributes(%new_attr);
609 # bb: todo: currency later
610 $self->order->currency_id($::instance_conf->get_currency_id());
612 my %pat = $self->order->calculate_prices_and_taxes();
614 foreach my $tax_chart_id (keys %{ $pat{taxes} }) {
615 my $tax = SL::DB::Manager::Tax->find_by(chart_id => $tax_chart_id);
617 my @amount_keys = grep { $pat{amounts}->{$_}->{tax_id} == $tax->id } keys %{ $pat{amounts} };
618 push(@{ $self->{taxes} }, { amount => $pat{taxes}->{$tax_chart_id},
619 netamount => $pat{amounts}->{$amount_keys[0]}->{amount},
623 pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items}, @{$pat{items}};
627 sub _get_unalterable_data {
630 foreach my $item (@{ $self->order->items }) {
632 # load data from orderitems (db)
633 my $db_item = SL::DB::OrderItem->new(id => $item->id)->load;
634 $item->$_($db_item->$_) for qw(longdescription);
636 # set data from part (or other sources)
637 $item->longdescription($item->part->notes);
640 # autovivify all cvars that are not in the form (cvars_by_config can do it).
641 # workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
642 foreach my $var (@{ $item->cvars_by_config }) {
643 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
645 $item->parse_custom_variable_values;
654 my $db = $self->order->db;
658 $self->order->save();
659 }) || push(@{$errors}, $db->error);
668 $self->{all_taxzones} = SL::DB::Manager::TaxZone->get_all_sorted();
669 $self->{all_departments} = SL::DB::Manager::Department->get_all_sorted();
670 $self->{all_employees} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->employee_id,
673 $self->{all_salesmen} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->salesman_id,
676 $self->{all_projects} = SL::DB::Manager::Project->get_all(where => [ or => [ id => $self->order->globalproject_id,
678 sort_by => 'projectnumber');
679 $self->{all_payment_terms} = SL::DB::Manager::PaymentTerm->get_all_sorted();
680 $self->{all_delivery_terms} = SL::DB::Manager::DeliveryTerm->get_all_sorted();
682 $self->{current_employee_id} = SL::DB::Manager::Employee->current->id;
684 foreach my $item (@{$self->order->items}) {
685 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
686 $item->active_price_source( $price_source->price_from_source( $item->active_price_source ));
687 $item->active_discount_source($price_source->discount_from_source($item->active_discount_source));
691 if ($self->order->ordnumber && $::instance_conf->get_webdav) {
692 my $webdav = SL::Webdav->new(
694 number => $self->order->ordnumber,
696 my $webdav_path = $webdav->webdav_path;
697 my @all_objects = $webdav->get_all_objects;
698 @{ $self->{template_args}->{WEBDAV} } = map { { name => $_->filename,
700 link => File::Spec->catdir($webdav_path, $_->filename),
704 $::request->{layout}->use_javascript("${_}.js") for qw(ckeditor/ckeditor ckeditor/adapters/jquery);
708 my ($order, $pdf_ref, $params) = @_;
710 my $print_form = Form->new('');
711 $print_form->{type} = $order->type;
712 $print_form->{formname} = $order->type;
713 $print_form->{format} = $params->{format} || 'pdf',
714 $print_form->{media} = $params->{media} || 'file';
716 $order->flatten_to_form($print_form, format_amounts => 1);
717 # flatten_to_form sets payment_terms from customer/vendor - we do not want that here
718 delete $print_form->{payment_terms} if !$print_form->{payment_id};
721 $print_form->throw_on_error(sub {
723 $print_form->prepare_for_printing;
725 $$pdf_ref = SL::Helper::CreatePDF->create_pdf(
726 template => SL::Helper::CreatePDF->find_template(name => $print_form->{formname}),
727 variables => $print_form,
728 variable_content_types => {
729 longdescription => 'html',
735 } || push @errors, ref($EVAL_ERROR) eq 'SL::X::FormError' ? $EVAL_ERROR->getMessage : $EVAL_ERROR;
741 sub _sales_order_type {
745 sub _purchase_order_type {
757 SL::Controller::Order - controller for orders
761 Testing, PriceSources, pricefactor, units, currency, delivered, delivery order created, ...
765 Bernd Bleßmann E<lt>bernd@kivitendo-premium.deE<gt>