1 package SL::Controller::Order;
4 use parent qw(SL::Controller::Base);
8 use SL::Locale::String;
9 use SL::SessionFile::Random;
25 use SL::Helper::DateTime;
26 use SL::Helper::CreatePDF qw(:all);
28 use SL::Controller::Helper::GetModels;
30 use List::Util qw(max first);
31 use List::MoreUtils qw(none pairwise first_index);
32 use English qw(-no_match_vars);
35 use Rose::Object::MakeMethods::Generic
37 scalar => [ qw(item_ids_to_delete) ],
38 'scalar --get_set_init' => [ qw(order valid_types type cv p multi_items_models) ],
43 __PACKAGE__->run_before('_check_auth');
45 __PACKAGE__->run_before('_recalc',
46 only => [ qw(update save save_and_delivery_order create_pdf send_email) ]);
48 __PACKAGE__->run_before('_get_unalterable_data',
49 only => [ qw(save save_and_delivery_order create_pdf send_email) ]);
58 $self->order->transdate(DateTime->now_local());
59 $self->order->reqdate(DateTime->today_local->next_workday) if !$self->order->reqdate;
64 title => $self->type eq _sales_order_type() ? $::locale->text('Add Sales Order')
65 : $self->type eq _purchase_order_type() ? $::locale->text('Add Purchase Order')
67 %{$self->{template_args}}
79 title => $self->type eq _sales_order_type() ? $::locale->text('Edit Sales Order')
80 : $self->type eq _purchase_order_type() ? $::locale->text('Edit Purchase Order')
82 %{$self->{template_args}}
92 title => $self->type eq _sales_order_type() ? $::locale->text('Edit Sales Order')
93 : $self->type eq _purchase_order_type() ? $::locale->text('Edit Purchase Order')
95 %{$self->{template_args}}
102 my $errors = $self->_delete();
104 if (scalar @{ $errors }) {
105 $self->js->flash('error', $_) foreach @{ $errors };
106 return $self->js->render();
109 flash_later('info', $::locale->text('The order has been deleted'));
110 my @redirect_params = (
115 $self->redirect_to(@redirect_params);
121 my $errors = $self->_save();
123 if (scalar @{ $errors }) {
124 $self->js->flash('error', $_) foreach @{ $errors };
125 return $self->js->render();
128 flash_later('info', $::locale->text('The order has been saved'));
129 my @redirect_params = (
132 id => $self->order->id,
135 $self->redirect_to(@redirect_params);
138 sub action_create_pdf {
142 my @errors = _create_pdf($self->order, \$pdf);
143 if (scalar @errors) {
144 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
147 my $sfile = SL::SessionFile::Random->new(mode => "w");
148 $sfile->fh->print($pdf);
151 my $key = join('_', Time::HiRes::gettimeofday(), int rand 1000000000000);
152 $::auth->set_session_value("Order::create_pdf-${key}" => $sfile->file_name);
154 my $form = Form->new;
155 $form->{ordnumber} = $self->order->ordnumber;
156 $form->{formname} = $self->type;
157 $form->{type} = $self->type;
158 $form->{language} = 'de';
159 $form->{format} = 'pdf';
161 my $pdf_filename = $form->generate_attachment_filename();
163 # copy file to webdav folder
164 if ($self->order->ordnumber && $::instance_conf->get_webdav_documents) {
165 my $webdav = SL::Webdav->new(
167 number => $self->order->ordnumber,
169 my $webdav_file = SL::Webdav::File->new(
171 filename => $pdf_filename,
174 $webdav_file->store(data => \$pdf);
177 $self->js->flash('error', t8('Storing PDF to webdav folder failed: #1', $@));
182 ->run('download_pdf', $pdf_filename, $key)
183 ->flash('info', t8('The PDF has been created'))->render($self);
186 sub action_download_pdf {
189 my $key = $::form->{key};
190 my $tmp_filename = $::auth->get_session_value("Order::create_pdf-${key}");
191 return $self->send_file(
193 type => 'application/pdf',
194 name => $::form->{pdf_filename},
198 sub action_show_email_dialog {
201 my $cv_method = $self->cv;
203 if (!$self->order->$cv_method) {
204 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'))
208 $self->{email}->{to} = $self->order->contact->cp_email if $self->order->contact;
209 $self->{email}->{to} ||= $self->order->$cv_method->email;
210 $self->{email}->{cc} = $self->order->$cv_method->cc;
211 $self->{email}->{bcc} = join ', ', grep $_, $self->order->$cv_method->bcc, SL::DB::Default->get->global_bcc;
212 # Todo: get addresses from shipto, if any
214 my $form = Form->new;
215 $form->{ordnumber} = $self->order->ordnumber;
216 $form->{formname} = $self->type;
217 $form->{type} = $self->type;
218 $form->{language} = 'de';
219 $form->{format} = 'pdf';
221 $self->{email}->{subject} = $form->generate_email_subject();
222 $self->{email}->{attachment_filename} = $form->generate_attachment_filename();
223 $self->{email}->{message} = $form->create_email_signature();
225 my $dialog_html = $self->render('order/tabs/_email_dialog', { output => 0 });
227 ->run('show_email_dialog', $dialog_html)
232 # Todo: handling error messages: flash is not displayed in dialog, but in the main form
233 sub action_send_email {
236 my $mail = Mailer->new;
237 $mail->{from} = qq|"$::myconfig{name}" <$::myconfig{email}>|;
238 $mail->{$_} = $::form->{email}->{$_} for qw(to cc bcc subject message);
241 my @errors = _create_pdf($self->order, \$pdf, {media => 'email'});
242 if (scalar @errors) {
243 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
246 $mail->{attachments} = [{ "content" => $pdf,
247 "name" => $::form->{email}->{attachment_filename} }];
249 if (my $err = $mail->send) {
250 return $self->js->flash('error', t8('Sending E-mail: ') . $err)
255 my $intnotes = $self->order->intnotes;
256 $intnotes .= "\n\n" if $self->order->intnotes;
257 $intnotes .= t8('[email]') . "\n";
258 $intnotes .= t8('Date') . ": " . $::locale->format_date_object(DateTime->now_local, precision => 'seconds') . "\n";
259 $intnotes .= t8('To (email)') . ": " . $mail->{to} . "\n";
260 $intnotes .= t8('Cc') . ": " . $mail->{cc} . "\n" if $mail->{cc};
261 $intnotes .= t8('Bcc') . ": " . $mail->{bcc} . "\n" if $mail->{bcc};
262 $intnotes .= t8('Subject') . ": " . $mail->{subject} . "\n\n";
263 $intnotes .= t8('Message') . ": " . $mail->{message};
266 ->val('#order_intnotes', $intnotes)
267 ->run('close_email_dialog')
271 sub action_save_and_delivery_order {
274 my $errors = $self->_save();
276 if (scalar @{ $errors }) {
277 $self->js->flash('error', $_) foreach @{ $errors };
278 return $self->js->render();
280 flash_later('info', $::locale->text('The order has been saved'));
282 my @redirect_params = (
283 controller => 'oe.pl',
284 action => 'oe_delivery_order_from_order',
285 id => $self->order->id,
288 $self->redirect_to(@redirect_params);
291 sub action_customer_vendor_changed {
294 my $cv_method = $self->cv;
296 if ($self->order->$cv_method->contacts && scalar @{ $self->order->$cv_method->contacts } > 0) {
297 $self->js->show('#cp_row');
299 $self->js->hide('#cp_row');
302 if ($self->order->$cv_method->shipto && scalar @{ $self->order->$cv_method->shipto } > 0) {
303 $self->js->show('#shipto_row');
305 $self->js->hide('#shipto_row');
308 $self->order->taxzone_id($self->order->$cv_method->taxzone_id);
310 if ($self->order->is_sales) {
311 $self->order->taxincluded(defined($self->order->$cv_method->taxincluded_checked)
312 ? $self->order->$cv_method->taxincluded_checked
313 : $::myconfig{taxincluded_checked});
316 $self->order->payment_id($self->order->$cv_method->payment_id);
317 $self->order->delivery_term_id($self->order->$cv_method->delivery_term_id);
322 ->replaceWith('#order_cp_id', $self->build_contact_select)
323 ->replaceWith('#order_shipto_id', $self->build_shipto_select)
324 ->val( '#order_taxzone_id', $self->order->taxzone_id)
325 ->val( '#order_taxincluded', $self->order->taxincluded)
326 ->val( '#order_payment_id', $self->order->payment_id)
327 ->val( '#order_delivery_term_id', $self->order->delivery_term_id)
328 ->val( '#order_intnotes', $self->order->$cv_method->notes)
329 ->focus( '#order_' . $self->cv . '_id');
331 $self->_js_redisplay_amounts_and_taxes;
335 sub action_unit_changed {
338 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
339 my $item = $self->order->items_sorted->[$idx];
341 my $old_unit_obj = SL::DB::Unit->new(name => $::form->{old_unit})->load;
342 $item->sellprice($item->unit_obj->convert_to($item->sellprice, $old_unit_obj));
347 ->run('update_sellprice', $::form->{item_id}, $item->sellprice_as_number);
348 $self->_js_redisplay_linetotals;
349 $self->_js_redisplay_amounts_and_taxes;
353 sub action_add_item {
356 my $form_attr = $::form->{add_item};
358 return unless $form_attr->{parts_id};
360 my $item = _new_item($self->order, $form_attr);
361 $self->order->add_items($item);
365 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
366 my $row_as_html = $self->p->render('order/tabs/_row', ITEM => $item, ID => $item_id);
369 ->append('#row_table_id', $row_as_html)
370 ->val('.add_item_input', '')
371 ->run('row_table_scroll_down')
372 ->run('row_set_keyboard_events_by_id', $item_id)
373 ->run('set_unit_change_with_oldval_by_id', $item_id)
374 ->on('.recalc', 'change', 'recalc_amounts_and_taxes')
375 ->on('.reformat_number', 'change', 'reformat_number')
376 ->focus('#add_item_parts_id_name');
378 $self->_js_redisplay_amounts_and_taxes;
382 sub action_show_multi_items_dialog {
383 require SL::DB::PartsGroup;
384 $_[0]->render('order/tabs/_multi_items_dialog', { layout => 0 },
385 all_partsgroups => SL::DB::Manager::PartsGroup->get_all);
388 sub action_multi_items_update_result {
390 my $count = $_[0]->multi_items_models->count;
393 my $text = SL::Presenter::EscapedText->new(text => $::locale->text('No results.'));
394 $_[0]->render($text, { layout => 0 });
395 } elsif ($count > $max_count) {
396 my $text = SL::Presenter::EscapedText->new(text => $::locale->text('Too many results (#1 from #2).', $count, $max_count));
397 $_[0]->render($text, { layout => 0 });
399 my $multi_items = $_[0]->multi_items_models->get;
400 $_[0]->render('order/tabs/_multi_items_result', { layout => 0 },
401 multi_items => $multi_items);
405 sub action_add_multi_items {
408 my @form_attr = grep { $_->{qty_as_number} } @{ $::form->{add_multi_items} };
409 return $self->js->render() unless scalar @form_attr;
412 foreach my $attr (@form_attr) {
413 push @items, _new_item($self->order, $attr);
415 $self->order->add_items(@items);
419 foreach my $item (@items) {
420 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
421 my $row_as_html = $self->p->render('order/tabs/_row', ITEM => $item, ID => $item_id);
424 ->append('#row_table_id', $row_as_html)
425 ->run('row_set_keyboard_events_by_id', $item_id)
426 ->run('set_unit_change_with_oldval_by_id', $item_id);
430 ->run('close_multi_items_dialog')
431 ->run('row_table_scroll_down')
432 ->on('.recalc', 'change', 'recalc_amounts_and_taxes')
433 ->on('.reformat_number', 'change', 'reformat_number')
434 ->focus('#add_item_parts_id_name');
436 $self->_js_redisplay_amounts_and_taxes;
440 sub action_recalc_amounts_and_taxes {
445 $self->_js_redisplay_linetotals;
446 $self->_js_redisplay_amounts_and_taxes;
450 sub action_price_popup {
453 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
454 my $item = $self->order->items_sorted->[$idx];
456 $self->render_price_dialog($item);
459 sub _js_redisplay_linetotals {
462 my @data = map {$::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0)} @{ $self->order->items_sorted };
464 ->run('redisplay_linetotals', \@data);
467 sub _js_redisplay_amounts_and_taxes {
470 if (scalar @{ $self->{taxes} }) {
471 $self->js->show('#taxincluded_row_id');
473 $self->js->hide('#taxincluded_row_id');
476 if ($self->order->taxincluded) {
477 $self->js->hide('#subtotal_row_id');
479 $self->js->show('#subtotal_row_id');
483 ->html('#netamount_id', $::form->format_amount(\%::myconfig, $self->order->netamount, -2))
484 ->html('#amount_id', $::form->format_amount(\%::myconfig, $self->order->amount, -2))
486 ->insertBefore($self->build_tax_rows, '#amount_row_id');
493 sub init_valid_types {
494 [ _sales_order_type(), _purchase_order_type() ];
500 if (none { $::form->{type} eq $_ } @{$self->valid_types}) {
501 die "Not a valid type for order";
504 $self->type($::form->{type});
510 my $cv = $self->type eq _sales_order_type() ? 'customer'
511 : $self->type eq _purchase_order_type() ? 'vendor'
512 : die "Not a valid type for order";
525 sub init_multi_items_models {
526 SL::Controller::Helper::GetModels->new(
529 with_objects => [ qw(unit_obj) ],
530 disable_plugin => 'paginated',
531 source => $::form->{multi_items},
537 partnumber => t8('Partnumber'),
538 description => t8('Description')}
545 my $right_for = { map { $_ => $_.'_edit' } @{$self->valid_types} };
547 my $right = $right_for->{ $self->type };
548 $right ||= 'DOES_NOT_EXIST';
550 $::auth->assert($right);
553 sub build_contact_select {
556 $self->p->select_tag('order.cp_id', [ $self->order->{$self->cv}->contacts ],
557 value_key => 'cp_id',
558 title_key => 'full_name_dep',
559 default => $self->order->cp_id,
561 style => 'width: 300px',
565 sub build_shipto_select {
568 $self->p->select_tag('order.shipto_id', [ $self->order->{$self->cv}->shipto ],
569 value_key => 'shipto_id',
570 title_key => 'displayable_id',
571 default => $self->order->shipto_id,
573 style => 'width: 300px',
581 foreach my $tax (sort { $a->{tax}->rate cmp $b->{tax}->rate } @{ $self->{taxes} }) {
582 $rows_as_html .= $self->p->render('order/tabs/_tax_row', TAX => $tax, TAXINCLUDED => $self->order->taxincluded);
584 return $rows_as_html;
588 sub render_price_dialog {
589 my ($self, $record_item) = @_;
591 my $price_source = SL::PriceSource->new(record_item => $record_item, record => $self->order);
595 'kivi.io.price_chooser_dialog',
596 t8('Available Prices'),
597 $self->render('order/tabs/_price_sources_dialog', { output => 0 }, price_source => $price_source)
602 # $self->js->text('#dialog_flash_error_content', join ' ', @errors);
603 # $self->js->show('#dialog_flash_error');
612 return if !$::form->{id};
614 $self->order(SL::DB::Manager::Order->find_by(id => $::form->{id}));
620 # add_items adds items to an order with no items for saving, but they cannot
621 # be retrieved via items until the order is saved. Adding empty items to new
622 # order here solves this problem.
624 $order = SL::DB::Manager::Order->find_by(id => $::form->{id}) if $::form->{id};
625 $order ||= SL::DB::Order->new(orderitems => []);
627 my $form_orderitems = delete $::form->{order}->{orderitems};
628 $order->assign_attributes(%{$::form->{order}});
630 # remove deleted items
631 $self->item_ids_to_delete([]);
632 foreach my $idx (reverse 0..$#{$order->orderitems}) {
633 my $item = $order->orderitems->[$idx];
634 if (none { $item->id == $_->{id} } @{$form_orderitems}) {
635 splice @{$order->orderitems}, $idx, 1;
636 push @{$self->item_ids_to_delete}, $item->id;
642 foreach my $form_attr (@{$form_orderitems}) {
643 my $item = _make_item($order, $form_attr);
644 $item->position($pos);
648 $order->add_items(grep {!$_->id} @items);
654 # Make item objects from form values. For items already existing read from db.
655 # Create a new item else. And assign attributes.
657 my ($record, $attr) = @_;
660 $item = first { $_->id == $attr->{id} } @{$record->items} if $attr->{id};
662 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
663 # they cannot be retrieved via custom_variables until the order/orderitem is
664 # saved. Adding empty custom_variables to new orderitem here solves this problem.
665 $item ||= SL::DB::OrderItem->new(custom_variables => []);
666 $item->assign_attributes(%$attr);
672 my ($record, $attr) = @_;
674 my $item = SL::DB::OrderItem->new;
675 $item->assign_attributes(%$attr);
677 my $part = SL::DB::Part->new(id => $attr->{parts_id})->load;
678 my $price_source = SL::PriceSource->new(record_item => $item, record => $record);
680 $item->unit($part->unit) if !$item->unit;
683 if ($item->sellprice) {
684 $price_src = $price_source->price_from_source("");
685 $price_src->price($item->sellprice);
687 $price_src = $price_source->best_price
688 ? $price_source->best_price
689 : $price_source->price_from_source("");
690 $price_src->price(0) if !$price_source->best_price;
694 if ($item->discount) {
695 $discount_src = $price_source->discount_from_source("");
696 $discount_src->discount($item->discount);
698 $discount_src = $price_source->best_discount
699 ? $price_source->best_discount
700 : $price_source->discount_from_source("");
701 $discount_src->discount(0) if !$price_source->best_discount;
705 $new_attr{part} = $part;
706 $new_attr{description} = $part->description if ! $item->description;
707 $new_attr{qty} = 1.0 if ! $item->qty;
708 $new_attr{sellprice} = $price_src->price;
709 $new_attr{discount} = $discount_src->discount;
710 $new_attr{active_price_source} = $price_src;
711 $new_attr{active_discount_source} = $discount_src;
713 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
714 # they cannot be retrieved via custom_variables until the order/orderitem is
715 # saved. Adding empty custom_variables to new orderitem here solves this problem.
716 $new_attr{custom_variables} = [];
718 $item->assign_attributes(%new_attr);
726 # bb: todo: currency later
727 $self->order->currency_id($::instance_conf->get_currency_id());
729 my %pat = $self->order->calculate_prices_and_taxes();
731 foreach my $tax_chart_id (keys %{ $pat{taxes} }) {
732 my $tax = SL::DB::Manager::Tax->find_by(chart_id => $tax_chart_id);
734 my @amount_keys = grep { $pat{amounts}->{$_}->{tax_id} == $tax->id } keys %{ $pat{amounts} };
735 push(@{ $self->{taxes} }, { amount => $pat{taxes}->{$tax_chart_id},
736 netamount => $pat{amounts}->{$amount_keys[0]}->{amount},
740 pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items}, @{$pat{items}};
744 sub _get_unalterable_data {
747 foreach my $item (@{ $self->order->items }) {
749 # load data from orderitems (db)
750 my $db_item = SL::DB::OrderItem->new(id => $item->id)->load;
751 $item->$_($db_item->$_) for qw(longdescription);
753 # set data from part (or other sources)
754 $item->longdescription($item->part->notes);
757 # autovivify all cvars that are not in the form (cvars_by_config can do it).
758 # workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
759 foreach my $var (@{ $item->cvars_by_config }) {
760 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
762 $item->parse_custom_variable_values;
771 my $db = $self->order->db;
775 my @spoolfiles = grep { $_ } map { $_->spoolfile } @{ SL::DB::Manager::Status->get_all(where => [ trans_id => $self->order->id ]) };
776 $self->order->delete;
777 my $spool = $::lx_office_conf{paths}->{spool};
778 unlink map { "$spool/$_" } @spoolfiles if $spool;
781 }) || push(@{$errors}, $db->error);
791 my $db = $self->order->db;
795 SL::DB::OrderItem->new(id => $_)->delete for @{$self->item_ids_to_delete};
796 $self->order->save(cascade => 1);
797 }) || push(@{$errors}, $db->error);
806 $self->{all_taxzones} = SL::DB::Manager::TaxZone->get_all_sorted();
807 $self->{all_departments} = SL::DB::Manager::Department->get_all_sorted();
808 $self->{all_employees} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->employee_id,
811 $self->{all_salesmen} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->salesman_id,
814 $self->{all_projects} = SL::DB::Manager::Project->get_all(where => [ or => [ id => $self->order->globalproject_id,
816 sort_by => 'projectnumber');
817 $self->{all_payment_terms} = SL::DB::Manager::PaymentTerm->get_all_sorted();
818 $self->{all_delivery_terms} = SL::DB::Manager::DeliveryTerm->get_all_sorted();
820 $self->{current_employee_id} = SL::DB::Manager::Employee->current->id;
822 foreach my $item (@{$self->order->orderitems}) {
823 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
824 $item->active_price_source( $price_source->price_from_source( $item->active_price_source ));
825 $item->active_discount_source($price_source->discount_from_source($item->active_discount_source));
828 if ($self->order->ordnumber && $::instance_conf->get_webdav) {
829 my $webdav = SL::Webdav->new(
831 number => $self->order->ordnumber,
833 my $webdav_path = $webdav->webdav_path;
834 my @all_objects = $webdav->get_all_objects;
835 @{ $self->{template_args}->{WEBDAV} } = map { { name => $_->filename,
837 link => File::Spec->catdir($webdav_path, $_->filename),
841 $::request->{layout}->use_javascript("${_}.js") for qw(ckeditor/ckeditor ckeditor/adapters/jquery);
845 my ($order, $pdf_ref, $params) = @_;
847 my $print_form = Form->new('');
848 $print_form->{type} = $order->type;
849 $print_form->{formname} = $order->type;
850 $print_form->{format} = $params->{format} || 'pdf',
851 $print_form->{media} = $params->{media} || 'file';
853 $order->flatten_to_form($print_form, format_amounts => 1);
854 # flatten_to_form sets payment_terms from customer/vendor - we do not want that here
855 delete $print_form->{payment_terms} if !$print_form->{payment_id};
858 $print_form->throw_on_error(sub {
860 $print_form->prepare_for_printing;
862 $$pdf_ref = SL::Helper::CreatePDF->create_pdf(
863 template => SL::Helper::CreatePDF->find_template(name => $print_form->{formname}),
864 variables => $print_form,
865 variable_content_types => {
866 longdescription => 'html',
872 } || push @errors, ref($EVAL_ERROR) eq 'SL::X::FormError' ? $EVAL_ERROR->getMessage : $EVAL_ERROR;
878 sub _sales_order_type {
882 sub _purchase_order_type {