1 package SL::Controller::Order;
4 use parent qw(SL::Controller::Base);
6 use SL::Helper::Flash qw(flash_later);
7 use SL::Presenter::Tag qw(select_tag hidden_tag div_tag);
8 use SL::Locale::String qw(t8);
9 use SL::SessionFile::Random;
14 use SL::Util qw(trim);
21 use SL::DB::PartClassification;
22 use SL::DB::PartsGroup;
25 use SL::DB::RecordLink;
27 use SL::DB::Translation;
29 use SL::Helper::CreatePDF qw(:all);
30 use SL::Helper::PrintOptions;
31 use SL::Helper::ShippedQty;
32 use SL::Helper::UserPreferences::PositionsScrollbar;
33 use SL::Helper::UserPreferences::UpdatePositions;
35 use SL::Controller::Helper::GetModels;
37 use List::Util qw(first sum0);
38 use List::UtilsBy qw(sort_by uniq_by);
39 use List::MoreUtils qw(any none pairwise first_index);
40 use English qw(-no_match_vars);
45 use Rose::Object::MakeMethods::Generic
47 scalar => [ qw(item_ids_to_delete is_custom_shipto_to_delete) ],
48 'scalar --get_set_init' => [ qw(order valid_types type cv p all_price_factors search_cvpartnumber show_update_button part_picker_classification_ids) ],
53 __PACKAGE__->run_before('check_auth');
55 __PACKAGE__->run_before('get_unalterable_data',
56 only => [ qw(save save_as_new save_and_delivery_order save_and_invoice save_and_ap_transaction
67 $self->order->transdate(DateTime->now_local());
68 my $extra_days = $self->type eq sales_quotation_type() ? $::instance_conf->get_reqdate_interval :
69 $self->type eq sales_order_type() ? $::instance_conf->get_delivery_date_interval : 1;
71 if ( ($self->type eq sales_order_type() && $::instance_conf->get_deliverydate_on)
72 || ($self->type eq sales_quotation_type() && $::instance_conf->get_reqdate_on)
73 && (!$self->order->reqdate)) {
74 $self->order->reqdate(DateTime->today_local->next_workday(extra_days => $extra_days));
81 title => $self->get_title_for('add'),
82 %{$self->{template_args}}
86 # edit an existing order
94 # this is to edit an order from an unsaved order object
96 # set item ids to new fake id, to identify them as new items
97 foreach my $item (@{$self->order->items_sorted}) {
98 $item->{new_fake_id} = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
100 # trigger rendering values for second row as hidden, because they
101 # are loaded only on demand. So we need to keep the values from
103 $_->{render_second_row} = 1 for @{ $self->order->items_sorted };
109 title => $self->get_title_for('edit'),
110 %{$self->{template_args}}
114 # edit a collective order (consisting of one or more existing orders)
115 sub action_edit_collective {
119 my @multi_ids = map {
120 $_ =~ m{^multi_id_(\d+)$} && $::form->{'multi_id_' . $1} && $::form->{'trans_id_' . $1} && $::form->{'trans_id_' . $1}
121 } grep { $_ =~ m{^multi_id_\d+$} } keys %$::form;
123 # fall back to add if no ids are given
124 if (scalar @multi_ids == 0) {
129 # fall back to save as new if only one id is given
130 if (scalar @multi_ids == 1) {
131 $self->order(SL::DB::Order->new(id => $multi_ids[0])->load);
132 $self->action_save_as_new();
136 # make new order from given orders
137 my @multi_orders = map { SL::DB::Order->new(id => $_)->load } @multi_ids;
138 $self->{converted_from_oe_id} = join ' ', map { $_->id } @multi_orders;
139 $self->order(SL::DB::Order->new_from_multi(\@multi_orders, sort_sources_by => 'transdate'));
141 $self->action_edit();
148 my $errors = $self->delete();
150 if (scalar @{ $errors }) {
151 $self->js->flash('error', $_) foreach @{ $errors };
152 return $self->js->render();
155 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been deleted')
156 : $self->type eq purchase_order_type() ? $::locale->text('The order has been deleted')
157 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been deleted')
158 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been deleted')
160 flash_later('info', $text);
162 my @redirect_params = (
167 $self->redirect_to(@redirect_params);
174 my $errors = $self->save();
176 if (scalar @{ $errors }) {
177 $self->js->flash('error', $_) foreach @{ $errors };
178 return $self->js->render();
181 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
182 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
183 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
184 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
186 flash_later('info', $text);
188 my @redirect_params = (
191 id => $self->order->id,
194 $self->redirect_to(@redirect_params);
197 # save the order as new document an open it for edit
198 sub action_save_as_new {
201 my $order = $self->order;
204 $self->js->flash('error', t8('This object has not been saved yet.'));
205 return $self->js->render();
208 # load order from db to check if values changed
209 my $saved_order = SL::DB::Order->new(id => $order->id)->load;
212 # Lets assign a new number if the user hasn't changed the previous one.
213 # If it has been changed manually then use it as-is.
214 $new_attrs{number} = (trim($order->number) eq $saved_order->number)
216 : trim($order->number);
218 # Clear transdate unless changed
219 $new_attrs{transdate} = ($order->transdate == $saved_order->transdate)
220 ? DateTime->today_local
223 # Set new reqdate unless changed if it is enabled in client config
224 if ($order->reqdate == $saved_order->reqdate) {
225 my $extra_days = $self->type eq sales_quotation_type() ? $::instance_conf->get_reqdate_interval :
226 $self->type eq sales_order_type() ? $::instance_conf->get_delivery_date_interval : 1;
228 if ( ($self->type eq sales_order_type() && !$::instance_conf->get_deliverydate_on)
229 || ($self->type eq sales_quotation_type() && !$::instance_conf->get_reqdate_on)) {
230 $new_attrs{reqdate} = '';
232 $new_attrs{reqdate} = DateTime->today_local->next_workday(extra_days => $extra_days);
235 $new_attrs{reqdate} = $order->reqdate;
239 $new_attrs{employee} = SL::DB::Manager::Employee->current;
241 # Create new record from current one
242 $self->order(SL::DB::Order->new_from($order, destination_type => $order->type, attributes => \%new_attrs));
244 # no linked records on save as new
245 delete $::form->{$_} for qw(converted_from_oe_id converted_from_orderitems_ids);
248 $self->action_save();
253 # This is called if "print" is pressed in the print dialog.
254 # If PDF creation was requested and succeeded, the pdf is offered for download
255 # via send_file (which uses ajax in this case).
259 my $errors = $self->save();
261 if (scalar @{ $errors }) {
262 $self->js->flash('error', $_) foreach @{ $errors };
263 return $self->js->render();
266 $self->js_reset_order_and_item_ids_after_save;
268 my $format = $::form->{print_options}->{format};
269 my $media = $::form->{print_options}->{media};
270 my $formname = $::form->{print_options}->{formname};
271 my $copies = $::form->{print_options}->{copies};
272 my $groupitems = $::form->{print_options}->{groupitems};
273 my $printer_id = $::form->{print_options}->{printer_id};
275 # only pdf and opendocument by now
276 if (none { $format eq $_ } qw(pdf opendocument opendocument_pdf)) {
277 return $self->js->flash('error', t8('Format \'#1\' is not supported yet/anymore.', $format))->render;
280 # only screen or printer by now
281 if (none { $media eq $_ } qw(screen printer)) {
282 return $self->js->flash('error', t8('Media \'#1\' is not supported yet/anymore.', $media))->render;
285 # create a form for generate_attachment_filename
286 my $form = Form->new;
287 $form->{$self->nr_key()} = $self->order->number;
288 $form->{type} = $self->type;
289 $form->{format} = $format;
290 $form->{formname} = $formname;
291 $form->{language} = '_' . $self->order->language->template_code if $self->order->language;
292 my $pdf_filename = $form->generate_attachment_filename();
295 my @errors = generate_pdf($self->order, \$pdf, { format => $format,
296 formname => $formname,
297 language => $self->order->language,
298 printer_id => $printer_id,
299 groupitems => $groupitems });
300 if (scalar @errors) {
301 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render;
304 if ($media eq 'screen') {
306 $self->js->flash('info', t8('The PDF has been created'));
309 type => SL::MIME->mime_type_from_ext($pdf_filename),
310 name => $pdf_filename,
314 } elsif ($media eq 'printer') {
316 my $printer_id = $::form->{print_options}->{printer_id};
317 SL::DB::Printer->new(id => $printer_id)->load->print_document(
322 $self->js->flash('info', t8('The PDF has been printed'));
325 my @warnings = store_pdf_to_webdav_and_filemanagement($self->order, $pdf, $pdf_filename);
326 if (scalar @warnings) {
327 $self->js->flash('warning', $_) for @warnings;
330 $self->save_history('PRINTED');
333 ->run('kivi.ActionBar.setEnabled', '#save_and_email_action')
336 sub action_preview_pdf {
339 my $errors = $self->save();
340 if (scalar @{ $errors }) {
341 $self->js->flash('error', $_) foreach @{ $errors };
342 return $self->js->render();
345 $self->js_reset_order_and_item_ids_after_save;
348 my $media = 'screen';
349 my $formname = $self->type;
352 # create a form for generate_attachment_filename
353 my $form = Form->new;
354 $form->{$self->nr_key()} = $self->order->number;
355 $form->{type} = $self->type;
356 $form->{format} = $format;
357 $form->{formname} = $formname;
358 $form->{language} = '_' . $self->order->language->template_code if $self->order->language;
359 my $pdf_filename = $form->generate_attachment_filename();
362 my @errors = generate_pdf($self->order, \$pdf, { format => $format,
363 formname => $formname,
364 language => $self->order->language,
366 if (scalar @errors) {
367 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render;
369 $self->save_history('PREVIEWED');
370 $self->js->flash('info', t8('The PDF has been previewed'));
374 type => SL::MIME->mime_type_from_ext($pdf_filename),
375 name => $pdf_filename,
380 # open the email dialog
381 sub action_save_and_show_email_dialog {
384 my $errors = $self->save();
386 if (scalar @{ $errors }) {
387 $self->js->flash('error', $_) foreach @{ $errors };
388 return $self->js->render();
391 my $cv_method = $self->cv;
393 if (!$self->order->$cv_method) {
394 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'))
399 $email_form->{to} = $self->order->contact->cp_email if $self->order->contact;
400 $email_form->{to} ||= $self->order->$cv_method->email;
401 $email_form->{cc} = $self->order->$cv_method->cc;
402 $email_form->{bcc} = join ', ', grep $_, $self->order->$cv_method->bcc, SL::DB::Default->get->global_bcc;
403 # Todo: get addresses from shipto, if any
405 my $form = Form->new;
406 $form->{$self->nr_key()} = $self->order->number;
407 $form->{cusordnumber} = $self->order->cusordnumber;
408 $form->{formname} = $self->type;
409 $form->{type} = $self->type;
410 $form->{language} = '_' . $self->order->language->template_code if $self->order->language;
411 $form->{language_id} = $self->order->language->id if $self->order->language;
412 $form->{format} = 'pdf';
413 $form->{cp_id} = $self->order->contact->cp_id if $self->order->contact;
415 $email_form->{subject} = $form->generate_email_subject();
416 $email_form->{attachment_filename} = $form->generate_attachment_filename();
417 $email_form->{message} = $form->generate_email_body();
418 $email_form->{js_send_function} = 'kivi.Order.send_email()';
420 my %files = $self->get_files_for_email_dialog();
421 $self->{all_employees} = SL::DB::Manager::Employee->get_all(query => [ deleted => 0 ]);
422 my $dialog_html = $self->render('common/_send_email_dialog', { output => 0 },
423 email_form => $email_form,
424 show_bcc => $::auth->assert('email_bcc', 'may fail'),
426 is_customer => $self->cv eq 'customer',
427 ALL_EMPLOYEES => $self->{all_employees},
431 ->run('kivi.Order.show_email_dialog', $dialog_html)
438 # Todo: handling error messages: flash is not displayed in dialog, but in the main form
439 sub action_send_email {
442 my $errors = $self->save();
444 if (scalar @{ $errors }) {
445 $self->js->run('kivi.Order.close_email_dialog');
446 $self->js->flash('error', $_) foreach @{ $errors };
447 return $self->js->render();
450 $self->js_reset_order_and_item_ids_after_save;
452 my $email_form = delete $::form->{email_form};
453 my %field_names = (to => 'email');
455 $::form->{ $field_names{$_} // $_ } = $email_form->{$_} for keys %{ $email_form };
457 # for Form::cleanup which may be called in Form::send_email
458 $::form->{cwd} = getcwd();
459 $::form->{tmpdir} = $::lx_office_conf{paths}->{userspath};
461 $::form->{$_} = $::form->{print_options}->{$_} for keys %{ $::form->{print_options} };
462 $::form->{media} = 'email';
464 if (($::form->{attachment_policy} // '') !~ m{^(?:old_file|no_file)$}) {
466 my @errors = generate_pdf($self->order, \$pdf, {media => $::form->{media},
467 format => $::form->{print_options}->{format},
468 formname => $::form->{print_options}->{formname},
469 language => $self->order->language,
470 printer_id => $::form->{print_options}->{printer_id},
471 groupitems => $::form->{print_options}->{groupitems}});
472 if (scalar @errors) {
473 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
476 my @warnings = store_pdf_to_webdav_and_filemanagement($self->order, $pdf, $::form->{attachment_filename});
477 if (scalar @warnings) {
478 flash_later('warning', $_) for @warnings;
481 my $sfile = SL::SessionFile::Random->new(mode => "w");
482 $sfile->fh->print($pdf);
485 $::form->{tmpfile} = $sfile->file_name;
486 $::form->{tmpdir} = $sfile->get_path; # for Form::cleanup which may be called in Form::send_email
489 $::form->{id} = $self->order->id; # this is used in SL::Mailer to create a linked record to the mail
490 $::form->send_email(\%::myconfig, 'pdf');
493 my $intnotes = $self->order->intnotes;
494 $intnotes .= "\n\n" if $self->order->intnotes;
495 $intnotes .= t8('[email]') . "\n";
496 $intnotes .= t8('Date') . ": " . $::locale->format_date_object(DateTime->now_local, precision => 'seconds') . "\n";
497 $intnotes .= t8('To (email)') . ": " . $::form->{email} . "\n";
498 $intnotes .= t8('Cc') . ": " . $::form->{cc} . "\n" if $::form->{cc};
499 $intnotes .= t8('Bcc') . ": " . $::form->{bcc} . "\n" if $::form->{bcc};
500 $intnotes .= t8('Subject') . ": " . $::form->{subject} . "\n\n";
501 $intnotes .= t8('Message') . ": " . $::form->{message};
503 $self->order->update_attributes(intnotes => $intnotes);
505 $self->save_history('MAILED');
507 flash_later('info', t8('The email has been sent.'));
509 my @redirect_params = (
512 id => $self->order->id,
515 $self->redirect_to(@redirect_params);
518 # save the order and redirect to the frontend subroutine for a new
520 sub action_save_and_delivery_order {
523 $self->save_and_redirect_to(
524 controller => 'oe.pl',
525 action => 'oe_delivery_order_from_order',
529 # save the order and redirect to the frontend subroutine for a new
531 sub action_save_and_invoice {
534 $self->save_and_redirect_to(
535 controller => 'oe.pl',
536 action => 'oe_invoice_from_order',
540 # workflow from sales order to sales quotation
541 sub action_sales_quotation {
542 $_[0]->workflow_sales_or_request_for_quotation();
545 # workflow from sales order to sales quotation
546 sub action_request_for_quotation {
547 $_[0]->workflow_sales_or_request_for_quotation();
550 # workflow from sales quotation to sales order
551 sub action_sales_order {
552 $_[0]->workflow_sales_or_purchase_order();
555 # workflow from rfq to purchase order
556 sub action_purchase_order {
557 $_[0]->workflow_sales_or_purchase_order();
560 # workflow from purchase order to ap transaction
561 sub action_save_and_ap_transaction {
564 $self->save_and_redirect_to(
565 controller => 'ap.pl',
566 action => 'add_from_purchase_order',
570 # set form elements in respect to a changed customer or vendor
572 # This action is called on an change of the customer/vendor picker.
573 sub action_customer_vendor_changed {
576 setup_order_from_cv($self->order);
578 my $cv_method = $self->cv;
580 if ($self->order->$cv_method->contacts && scalar @{ $self->order->$cv_method->contacts } > 0) {
581 $self->js->show('#cp_row');
583 $self->js->hide('#cp_row');
586 if ($self->order->$cv_method->shipto && scalar @{ $self->order->$cv_method->shipto } > 0) {
587 $self->js->show('#shipto_selection');
589 $self->js->hide('#shipto_selection');
592 $self->js->val( '#order_salesman_id', $self->order->salesman_id) if $self->order->is_sales;
595 ->replaceWith('#order_cp_id', $self->build_contact_select)
596 ->replaceWith('#order_shipto_id', $self->build_shipto_select)
597 ->replaceWith('#shipto_inputs ', $self->build_shipto_inputs)
598 ->replaceWith('#business_info_row', $self->build_business_info_row)
599 ->val( '#order_taxzone_id', $self->order->taxzone_id)
600 ->val( '#order_taxincluded', $self->order->taxincluded)
601 ->val( '#order_currency_id', $self->order->currency_id)
602 ->val( '#order_payment_id', $self->order->payment_id)
603 ->val( '#order_delivery_term_id', $self->order->delivery_term_id)
604 ->val( '#order_intnotes', $self->order->intnotes)
605 ->val( '#order_language_id', $self->order->$cv_method->language_id)
606 ->focus( '#order_' . $self->cv . '_id')
607 ->run('kivi.Order.update_exchangerate');
609 $self->js_redisplay_cvpartnumbers;
613 # open the dialog for customer/vendor details
614 sub action_show_customer_vendor_details_dialog {
617 my $is_customer = 'customer' eq $::form->{vc};
620 $cv = SL::DB::Customer->new(id => $::form->{vc_id})->load;
622 $cv = SL::DB::Vendor->new(id => $::form->{vc_id})->load;
625 my %details = map { $_ => $cv->$_ } @{$cv->meta->columns};
626 $details{discount_as_percent} = $cv->discount_as_percent;
627 $details{creditlimt} = $cv->creditlimit_as_number;
628 $details{business} = $cv->business->description if $cv->business;
629 $details{language} = $cv->language_obj->description if $cv->language_obj;
630 $details{delivery_terms} = $cv->delivery_term->description if $cv->delivery_term;
631 $details{payment_terms} = $cv->payment->description if $cv->payment;
632 $details{pricegroup} = $cv->pricegroup->pricegroup if $is_customer && $cv->pricegroup;
634 foreach my $entry (@{ $cv->shipto }) {
635 push @{ $details{SHIPTO} }, { map { $_ => $entry->$_ } @{$entry->meta->columns} };
637 foreach my $entry (@{ $cv->contacts }) {
638 push @{ $details{CONTACTS} }, { map { $_ => $entry->$_ } @{$entry->meta->columns} };
641 $_[0]->render('common/show_vc_details', { layout => 0 },
642 is_customer => $is_customer,
647 # called if a unit in an existing item row is changed
648 sub action_unit_changed {
651 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
652 my $item = $self->order->items_sorted->[$idx];
654 my $old_unit_obj = SL::DB::Unit->new(name => $::form->{old_unit})->load;
655 $item->sellprice($item->unit_obj->convert_to($item->sellprice, $old_unit_obj));
658 ->run('kivi.Order.update_sellprice', $::form->{item_id}, $item->sellprice_as_number);
659 $self->js_redisplay_line_values;
663 # add an item row for a new item entered in the input row
664 sub action_add_item {
667 delete $::form->{add_item}->{create_part_type};
669 my $form_attr = $::form->{add_item};
671 return unless $form_attr->{parts_id};
673 my $item = new_item($self->order, $form_attr);
675 $self->order->add_items($item);
677 $self->get_item_cvpartnumber($item);
679 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
680 my $row_as_html = $self->p->render('order/tabs/_row',
686 if ($::form->{insert_before_item_id}) {
688 ->before ('.row_entry:has(#item_' . $::form->{insert_before_item_id} . ')', $row_as_html);
691 ->append('#row_table_id', $row_as_html);
694 if ( $item->part->is_assortment ) {
695 $form_attr->{qty_as_number} = 1 unless $form_attr->{qty_as_number};
696 foreach my $assortment_item ( @{$item->part->assortment_items} ) {
697 my $attr = { parts_id => $assortment_item->parts_id,
698 qty => $assortment_item->qty * $::form->parse_amount(\%::myconfig, $form_attr->{qty_as_number}), # TODO $form_attr->{unit}
699 unit => $assortment_item->unit,
700 description => $assortment_item->part->description,
702 my $item = new_item($self->order, $attr);
704 # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount
705 $item->discount(1) unless $assortment_item->charge;
707 $self->order->add_items( $item );
708 $self->get_item_cvpartnumber($item);
709 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
710 my $row_as_html = $self->p->render('order/tabs/_row',
715 if ($::form->{insert_before_item_id}) {
717 ->before ('.row_entry:has(#item_' . $::form->{insert_before_item_id} . ')', $row_as_html);
720 ->append('#row_table_id', $row_as_html);
726 ->val('.add_item_input', '')
727 ->run('kivi.Order.init_row_handlers')
728 ->run('kivi.Order.renumber_positions')
729 ->focus('#add_item_parts_id_name');
731 $self->js->run('kivi.Order.row_table_scroll_down') if !$::form->{insert_before_item_id};
736 # add item rows for multiple items at once
737 sub action_add_multi_items {
740 my @form_attr = grep { $_->{qty_as_number} } @{ $::form->{add_items} };
741 return $self->js->render() unless scalar @form_attr;
744 foreach my $attr (@form_attr) {
745 my $item = new_item($self->order, $attr);
747 if ( $item->part->is_assortment ) {
748 foreach my $assortment_item ( @{$item->part->assortment_items} ) {
749 my $attr = { parts_id => $assortment_item->parts_id,
750 qty => $assortment_item->qty * $item->qty, # TODO $form_attr->{unit}
751 unit => $assortment_item->unit,
752 description => $assortment_item->part->description,
754 my $item = new_item($self->order, $attr);
756 # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount
757 $item->discount(1) unless $assortment_item->charge;
762 $self->order->add_items(@items);
764 foreach my $item (@items) {
765 $self->get_item_cvpartnumber($item);
766 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
767 my $row_as_html = $self->p->render('order/tabs/_row',
773 if ($::form->{insert_before_item_id}) {
775 ->before ('.row_entry:has(#item_' . $::form->{insert_before_item_id} . ')', $row_as_html);
778 ->append('#row_table_id', $row_as_html);
783 ->run('kivi.Part.close_picker_dialogs')
784 ->run('kivi.Order.init_row_handlers')
785 ->run('kivi.Order.renumber_positions')
786 ->focus('#add_item_parts_id_name');
788 $self->js->run('kivi.Order.row_table_scroll_down') if !$::form->{insert_before_item_id};
793 sub action_update_exchangerate {
797 is_standard => $self->order->currency_id == $::instance_conf->get_currency_id,
798 currency_name => $self->order->currency->name,
799 exchangerate => $self->order->daily_exchangerate_as_null_number,
802 $self->render(\SL::JSON::to_json($data), { type => 'json', process => 0 });
805 # redisplay item rows if they are sorted by an attribute
806 sub action_reorder_items {
810 partnumber => sub { $_[0]->part->partnumber },
811 description => sub { $_[0]->description },
812 qty => sub { $_[0]->qty },
813 sellprice => sub { $_[0]->sellprice },
814 discount => sub { $_[0]->discount },
815 cvpartnumber => sub { $_[0]->{cvpartnumber} },
818 $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
820 my $method = $sort_keys{$::form->{order_by}};
821 my @to_sort = map { { old_pos => $_->position, order_by => $method->($_) } } @{ $self->order->items_sorted };
822 if ($::form->{sort_dir}) {
823 if ( $::form->{order_by} =~ m/qty|sellprice|discount/ ){
824 @to_sort = sort { $a->{order_by} <=> $b->{order_by} } @to_sort;
826 @to_sort = sort { $a->{order_by} cmp $b->{order_by} } @to_sort;
829 if ( $::form->{order_by} =~ m/qty|sellprice|discount/ ){
830 @to_sort = sort { $b->{order_by} <=> $a->{order_by} } @to_sort;
832 @to_sort = sort { $b->{order_by} cmp $a->{order_by} } @to_sort;
836 ->run('kivi.Order.redisplay_items', \@to_sort)
840 # show the popup to choose a price/discount source
841 sub action_price_popup {
844 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
845 my $item = $self->order->items_sorted->[$idx];
847 $self->render_price_dialog($item);
850 # save the order in a session variable and redirect to the part controller
851 sub action_create_part {
854 my $previousform = $::auth->save_form_in_session(non_scalars => 1);
856 my $callback = $self->url_for(
857 action => 'return_from_create_part',
858 type => $self->type, # type is needed for check_auth on return
859 previousform => $previousform,
862 flash_later('info', t8('You are adding a new part while you are editing another document. You will be redirected to your document when saving the new part or aborting this form.'));
864 my @redirect_params = (
865 controller => 'Part',
867 part_type => $::form->{add_item}->{create_part_type},
868 callback => $callback,
872 $self->redirect_to(@redirect_params);
875 sub action_return_from_create_part {
878 $self->{created_part} = SL::DB::Part->new(id => delete $::form->{new_parts_id})->load if $::form->{new_parts_id};
880 $::auth->restore_form_from_session(delete $::form->{previousform});
882 # set item ids to new fake id, to identify them as new items
883 foreach my $item (@{$self->order->items_sorted}) {
884 $item->{new_fake_id} = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
887 $self->get_unalterable_data();
890 # trigger rendering values for second row/longdescription as hidden,
891 # because they are loaded only on demand. So we need to keep the values
893 $_->{render_second_row} = 1 for @{ $self->order->items_sorted };
894 $_->{render_longdescription} = 1 for @{ $self->order->items_sorted };
898 title => $self->get_title_for('edit'),
899 %{$self->{template_args}}
904 # load the second row for one or more items
906 # This action gets the html code for all items second rows by rendering a template for
907 # the second row and sets the html code via client js.
908 sub action_load_second_rows {
911 foreach my $item_id (@{ $::form->{item_ids} }) {
912 my $idx = first_index { $_ eq $item_id } @{ $::form->{orderitem_ids} };
913 my $item = $self->order->items_sorted->[$idx];
915 $self->js_load_second_row($item, $item_id, 0);
918 $self->js->run('kivi.Order.init_row_handlers') if $self->order->is_sales; # for lastcosts change-callback
923 # update description, notes and sellprice from master data
924 sub action_update_row_from_master_data {
927 foreach my $item_id (@{ $::form->{item_ids} }) {
928 my $idx = first_index { $_ eq $item_id } @{ $::form->{orderitem_ids} };
929 my $item = $self->order->items_sorted->[$idx];
930 my $texts = get_part_texts($item->part, $self->order->language_id);
932 $item->description($texts->{description});
933 $item->longdescription($texts->{longdescription});
935 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
938 if ($item->part->is_assortment) {
939 # add assortment items with price 0, as the components carry the price
940 $price_src = $price_source->price_from_source("");
941 $price_src->price(0);
943 $price_src = $price_source->best_price
944 ? $price_source->best_price
945 : $price_source->price_from_source("");
946 $price_src->price($::form->round_amount($price_src->price / $self->order->exchangerate, 5)) if $self->order->exchangerate;
947 $price_src->price(0) if !$price_source->best_price;
951 $item->sellprice($price_src->price);
952 $item->active_price_source($price_src);
955 ->run('kivi.Order.update_sellprice', $item_id, $item->sellprice_as_number)
956 ->html('.row_entry:has(#item_' . $item_id . ') [name = "partnumber"] a', $item->part->partnumber)
957 ->val ('.row_entry:has(#item_' . $item_id . ') [name = "order.orderitems[].description"]', $item->description)
958 ->val ('.row_entry:has(#item_' . $item_id . ') [name = "order.orderitems[].longdescription"]', $item->longdescription);
960 if ($self->search_cvpartnumber) {
961 $self->get_item_cvpartnumber($item);
962 $self->js->html('.row_entry:has(#item_' . $item_id . ') [name = "cvpartnumber"]', $item->{cvpartnumber});
966 $self->js_redisplay_line_values;
971 sub js_load_second_row {
972 my ($self, $item, $item_id, $do_parse) = @_;
975 # Parse values from form (they are formated while rendering (template)).
976 # Workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
977 # This parsing is not necessary at all, if we assure that the second row/cvars are only loaded once.
978 foreach my $var (@{ $item->cvars_by_config }) {
979 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
981 $item->parse_custom_variable_values;
984 my $row_as_html = $self->p->render('order/tabs/_second_row', ITEM => $item, TYPE => $self->type);
987 ->html('#second_row_' . $item_id, $row_as_html)
988 ->data('#second_row_' . $item_id, 'loaded', 1);
991 sub js_redisplay_line_values {
994 my $is_sales = $self->order->is_sales;
996 # sales orders with margins
1001 $::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0),
1002 $::form->format_amount(\%::myconfig, $_->{marge_total}, 2, 0),
1003 $::form->format_amount(\%::myconfig, $_->{marge_percent}, 2, 0),
1004 ]} @{ $self->order->items_sorted };
1008 $::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0),
1009 ]} @{ $self->order->items_sorted };
1013 ->run('kivi.Order.redisplay_line_values', $is_sales, \@data);
1016 sub js_redisplay_cvpartnumbers {
1019 $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
1021 my @data = map {[$_->{cvpartnumber}]} @{ $self->order->items_sorted };
1024 ->run('kivi.Order.redisplay_cvpartnumbers', \@data);
1027 sub js_reset_order_and_item_ids_after_save {
1031 ->val('#id', $self->order->id)
1032 ->val('#converted_from_oe_id', '')
1033 ->val('#order_' . $self->nr_key(), $self->order->number);
1036 foreach my $form_item_id (@{ $::form->{orderitem_ids} }) {
1037 next if !$self->order->items_sorted->[$idx]->id;
1038 next if $form_item_id !~ m{^new};
1040 ->val ('[name="orderitem_ids[+]"][value="' . $form_item_id . '"]', $self->order->items_sorted->[$idx]->id)
1041 ->val ('#item_' . $form_item_id, $self->order->items_sorted->[$idx]->id)
1042 ->attr('#item_' . $form_item_id, "id", 'item_' . $self->order->items_sorted->[$idx]->id);
1046 $self->js->val('[name="converted_from_orderitems_ids[+]"]', '');
1053 sub init_valid_types {
1054 [ sales_order_type(), purchase_order_type(), sales_quotation_type(), request_quotation_type() ];
1060 if (none { $::form->{type} eq $_ } @{$self->valid_types}) {
1061 die "Not a valid type for order";
1064 $self->type($::form->{type});
1070 my $cv = (any { $self->type eq $_ } (sales_order_type(), sales_quotation_type())) ? 'customer'
1071 : (any { $self->type eq $_ } (purchase_order_type(), request_quotation_type())) ? 'vendor'
1072 : die "Not a valid type for order";
1077 sub init_search_cvpartnumber {
1080 my $user_prefs = SL::Helper::UserPreferences::PartPickerSearch->new();
1081 my $search_cvpartnumber;
1082 $search_cvpartnumber = !!$user_prefs->get_sales_search_customer_partnumber() if $self->cv eq 'customer';
1083 $search_cvpartnumber = !!$user_prefs->get_purchase_search_makemodel() if $self->cv eq 'vendor';
1085 return $search_cvpartnumber;
1088 sub init_show_update_button {
1091 !!SL::Helper::UserPreferences::UpdatePositions->new()->get_show_update_button();
1102 sub init_all_price_factors {
1103 SL::DB::Manager::PriceFactor->get_all;
1106 sub init_part_picker_classification_ids {
1108 my $attribute = 'used_for_' . ($self->type =~ m{sales} ? 'sale' : 'purchase');
1110 return [ map { $_->id } @{ SL::DB::Manager::PartClassification->get_all(where => [ $attribute => 1 ]) } ];
1116 my $right_for = { map { $_ => $_.'_edit' } @{$self->valid_types} };
1118 my $right = $right_for->{ $self->type };
1119 $right ||= 'DOES_NOT_EXIST';
1121 $::auth->assert($right);
1124 # build the selection box for contacts
1126 # Needed, if customer/vendor changed.
1127 sub build_contact_select {
1130 select_tag('order.cp_id', [ $self->order->{$self->cv}->contacts ],
1131 value_key => 'cp_id',
1132 title_key => 'full_name_dep',
1133 default => $self->order->cp_id,
1135 style => 'width: 300px',
1139 # build the selection box for shiptos
1141 # Needed, if customer/vendor changed.
1142 sub build_shipto_select {
1145 select_tag('order.shipto_id',
1146 [ {displayable_id => t8("No/individual shipping address"), shipto_id => ''}, $self->order->{$self->cv}->shipto ],
1147 value_key => 'shipto_id',
1148 title_key => 'displayable_id',
1149 default => $self->order->shipto_id,
1151 style => 'width: 300px',
1155 # build the inputs for the cusom shipto dialog
1157 # Needed, if customer/vendor changed.
1158 sub build_shipto_inputs {
1161 my $content = $self->p->render('common/_ship_to_dialog',
1162 vc_obj => $self->order->customervendor,
1163 cs_obj => $self->order->custom_shipto,
1164 cvars => $self->order->custom_shipto->cvars_by_config,
1165 id_selector => '#order_shipto_id');
1167 div_tag($content, id => 'shipto_inputs');
1170 # render the info line for business
1172 # Needed, if customer/vendor changed.
1173 sub build_business_info_row
1175 $_[0]->p->render('order/tabs/_business_info_row', SELF => $_[0]);
1179 sub render_price_dialog {
1180 my ($self, $record_item) = @_;
1182 my $price_source = SL::PriceSource->new(record_item => $record_item, record => $self->order);
1186 'kivi.io.price_chooser_dialog',
1187 t8('Available Prices'),
1188 $self->render('order/tabs/_price_sources_dialog', { output => 0 }, price_source => $price_source)
1193 # $self->js->text('#dialog_flash_error_content', join ' ', @errors);
1194 # $self->js->show('#dialog_flash_error');
1203 return if !$::form->{id};
1205 $self->order(SL::DB::Order->new(id => $::form->{id})->load);
1207 # Add an empty custom shipto to the order, so that the dialog can render the cvar inputs.
1208 # You need a custom shipto object to call cvars_by_config to get the cvars.
1209 $self->order->custom_shipto(SL::DB::Shipto->new(module => 'OE', custom_variables => [])) if !$self->order->custom_shipto;
1211 return $self->order;
1214 # load or create a new order object
1216 # And assign changes from the form to this object.
1217 # If the order is loaded from db, check if items are deleted in the form,
1218 # remove them form the object and collect them for removing from db on saving.
1219 # Then create/update items from form (via make_item) and add them.
1223 # add_items adds items to an order with no items for saving, but they cannot
1224 # be retrieved via items until the order is saved. Adding empty items to new
1225 # order here solves this problem.
1227 $order = SL::DB::Order->new(id => $::form->{id})->load(with => [ 'orderitems', 'orderitems.part' ]) if $::form->{id};
1228 $order ||= SL::DB::Order->new(orderitems => [],
1229 quotation => (any { $self->type eq $_ } (sales_quotation_type(), request_quotation_type())),
1230 currency_id => $::instance_conf->get_currency_id(),);
1232 my $cv_id_method = $self->cv . '_id';
1233 if (!$::form->{id} && $::form->{$cv_id_method}) {
1234 $order->$cv_id_method($::form->{$cv_id_method});
1235 setup_order_from_cv($order);
1238 my $form_orderitems = delete $::form->{order}->{orderitems};
1240 $order->assign_attributes(%{$::form->{order}});
1242 $self->setup_custom_shipto_from_form($order, $::form);
1244 # remove deleted items
1245 $self->item_ids_to_delete([]);
1246 foreach my $idx (reverse 0..$#{$order->orderitems}) {
1247 my $item = $order->orderitems->[$idx];
1248 if (none { $item->id == $_->{id} } @{$form_orderitems}) {
1249 splice @{$order->orderitems}, $idx, 1;
1250 push @{$self->item_ids_to_delete}, $item->id;
1256 foreach my $form_attr (@{$form_orderitems}) {
1257 my $item = make_item($order, $form_attr);
1258 $item->position($pos);
1262 $order->add_items(grep {!$_->id} @items);
1267 # create or update items from form
1269 # Make item objects from form values. For items already existing read from db.
1270 # Create a new item else. And assign attributes.
1272 my ($record, $attr) = @_;
1275 $item = first { $_->id == $attr->{id} } @{$record->items} if $attr->{id};
1277 my $is_new = !$item;
1279 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
1280 # they cannot be retrieved via custom_variables until the order/orderitem is
1281 # saved. Adding empty custom_variables to new orderitem here solves this problem.
1282 $item ||= SL::DB::OrderItem->new(custom_variables => []);
1284 $item->assign_attributes(%$attr);
1287 my $texts = get_part_texts($item->part, $record->language_id);
1288 $item->longdescription($texts->{longdescription}) if !defined $attr->{longdescription};
1289 $item->project_id($record->globalproject_id) if !defined $attr->{project_id};
1290 $item->lastcost($record->is_sales ? $item->part->lastcost : 0) if !defined $attr->{lastcost_as_number};
1298 # This is used to add one item
1300 my ($record, $attr) = @_;
1302 my $item = SL::DB::OrderItem->new;
1304 # Remove attributes where the user left or set the inputs empty.
1305 # So these attributes will be undefined and we can distinguish them
1306 # from zero later on.
1307 for (qw(qty_as_number sellprice_as_number discount_as_percent)) {
1308 delete $attr->{$_} if $attr->{$_} eq '';
1311 $item->assign_attributes(%$attr);
1313 my $part = SL::DB::Part->new(id => $attr->{parts_id})->load;
1314 my $price_source = SL::PriceSource->new(record_item => $item, record => $record);
1316 $item->unit($part->unit) if !$item->unit;
1319 if ( $part->is_assortment ) {
1320 # add assortment items with price 0, as the components carry the price
1321 $price_src = $price_source->price_from_source("");
1322 $price_src->price(0);
1323 } elsif (defined $item->sellprice) {
1324 $price_src = $price_source->price_from_source("");
1325 $price_src->price($item->sellprice);
1327 $price_src = $price_source->best_price
1328 ? $price_source->best_price
1329 : $price_source->price_from_source("");
1330 $price_src->price($::form->round_amount($price_src->price / $record->exchangerate, 5)) if $record->exchangerate;
1331 $price_src->price(0) if !$price_source->best_price;
1335 if (defined $item->discount) {
1336 $discount_src = $price_source->discount_from_source("");
1337 $discount_src->discount($item->discount);
1339 $discount_src = $price_source->best_discount
1340 ? $price_source->best_discount
1341 : $price_source->discount_from_source("");
1342 $discount_src->discount(0) if !$price_source->best_discount;
1346 $new_attr{part} = $part;
1347 $new_attr{description} = $part->description if ! $item->description;
1348 $new_attr{qty} = 1.0 if ! $item->qty;
1349 $new_attr{price_factor_id} = $part->price_factor_id if ! $item->price_factor_id;
1350 $new_attr{sellprice} = $price_src->price;
1351 $new_attr{discount} = $discount_src->discount;
1352 $new_attr{active_price_source} = $price_src;
1353 $new_attr{active_discount_source} = $discount_src;
1354 $new_attr{longdescription} = $part->notes if ! defined $attr->{longdescription};
1355 $new_attr{project_id} = $record->globalproject_id;
1356 $new_attr{lastcost} = $record->is_sales ? $part->lastcost : 0;
1358 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
1359 # they cannot be retrieved via custom_variables until the order/orderitem is
1360 # saved. Adding empty custom_variables to new orderitem here solves this problem.
1361 $new_attr{custom_variables} = [];
1363 my $texts = get_part_texts($part, $record->language_id, description => $new_attr{description}, longdescription => $new_attr{longdescription});
1365 $item->assign_attributes(%new_attr, %{ $texts });
1370 sub setup_order_from_cv {
1373 $order->$_($order->customervendor->$_) for (qw(taxzone_id payment_id delivery_term_id currency_id));
1375 $order->intnotes($order->customervendor->notes);
1377 if ($order->is_sales) {
1378 $order->salesman_id($order->customer->salesman_id || SL::DB::Manager::Employee->current->id);
1379 $order->taxincluded(defined($order->customer->taxincluded_checked)
1380 ? $order->customer->taxincluded_checked
1381 : $::myconfig{taxincluded_checked});
1386 # setup custom shipto from form
1388 # The dialog returns form variables starting with 'shipto' and cvars starting
1389 # with 'shiptocvar_'.
1390 # Mark it to be deleted if a shipto from master data is selected
1391 # (i.e. order has a shipto).
1392 # Else, update or create a new custom shipto. If the fields are empty, it
1393 # will not be saved on save.
1394 sub setup_custom_shipto_from_form {
1395 my ($self, $order, $form) = @_;
1397 if ($order->shipto) {
1398 $self->is_custom_shipto_to_delete(1);
1400 my $custom_shipto = $order->custom_shipto || $order->custom_shipto(SL::DB::Shipto->new(module => 'OE', custom_variables => []));
1402 my $shipto_cvars = {map { my ($key) = m{^shiptocvar_(.+)}; $key => delete $form->{$_}} grep { m{^shiptocvar_} } keys %$form};
1403 my $shipto_attrs = {map { $_ => delete $form->{$_}} grep { m{^shipto} } keys %$form};
1405 $custom_shipto->assign_attributes(%$shipto_attrs);
1406 $custom_shipto->cvar_by_name($_)->value($shipto_cvars->{$_}) for keys %$shipto_cvars;
1410 # get data for saving, printing, ..., that is not changed in the form
1412 # Only cvars for now.
1413 sub get_unalterable_data {
1416 foreach my $item (@{ $self->order->items }) {
1417 # autovivify all cvars that are not in the form (cvars_by_config can do it).
1418 # workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
1419 foreach my $var (@{ $item->cvars_by_config }) {
1420 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
1422 $item->parse_custom_variable_values;
1428 # And remove related files in the spool directory
1433 my $db = $self->order->db;
1435 $db->with_transaction(
1437 my @spoolfiles = grep { $_ } map { $_->spoolfile } @{ SL::DB::Manager::Status->get_all(where => [ trans_id => $self->order->id ]) };
1438 $self->order->delete;
1439 my $spool = $::lx_office_conf{paths}->{spool};
1440 unlink map { "$spool/$_" } @spoolfiles if $spool;
1442 $self->save_history('DELETED');
1445 }) || push(@{$errors}, $db->error);
1452 # And delete items that are deleted in the form.
1457 my $db = $self->order->db;
1459 $db->with_transaction(sub {
1460 # delete custom shipto if it is to be deleted or if it is empty
1461 if ($self->order->custom_shipto && ($self->is_custom_shipto_to_delete || $self->order->custom_shipto->is_empty)) {
1462 $self->order->custom_shipto->delete if $self->order->custom_shipto->shipto_id;
1463 $self->order->custom_shipto(undef);
1466 SL::DB::OrderItem->new(id => $_)->delete for @{$self->item_ids_to_delete || []};
1467 $self->order->save(cascade => 1);
1470 if ($::form->{converted_from_oe_id}) {
1471 my @converted_from_oe_ids = split ' ', $::form->{converted_from_oe_id};
1472 foreach my $converted_from_oe_id (@converted_from_oe_ids) {
1473 my $src = SL::DB::Order->new(id => $converted_from_oe_id)->load;
1474 $src->update_attributes(closed => 1) if $src->type =~ /_quotation$/;
1475 $src->link_to_record($self->order);
1477 if (scalar @{ $::form->{converted_from_orderitems_ids} || [] }) {
1479 foreach (@{ $self->order->items_sorted }) {
1480 my $from_id = $::form->{converted_from_orderitems_ids}->[$idx];
1482 SL::DB::RecordLink->new(from_table => 'orderitems',
1483 from_id => $from_id,
1484 to_table => 'orderitems',
1492 $self->save_history('SAVED');
1495 }) || push(@{$errors}, $db->error);
1500 sub workflow_sales_or_request_for_quotation {
1504 my $errors = $self->save();
1506 if (scalar @{ $errors }) {
1507 $self->js->flash('error', $_) for @{ $errors };
1508 return $self->js->render();
1511 my $destination_type = $::form->{type} eq sales_order_type() ? sales_quotation_type() : request_quotation_type();
1513 $self->order(SL::DB::Order->new_from($self->order, destination_type => $destination_type));
1514 $self->{converted_from_oe_id} = delete $::form->{id};
1516 # set item ids to new fake id, to identify them as new items
1517 foreach my $item (@{$self->order->items_sorted}) {
1518 $item->{new_fake_id} = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
1522 $::form->{type} = $destination_type;
1523 $self->type($self->init_type);
1524 $self->cv ($self->init_cv);
1527 $self->get_unalterable_data();
1528 $self->pre_render();
1530 # trigger rendering values for second row as hidden, because they
1531 # are loaded only on demand. So we need to keep the values from the
1533 $_->{render_second_row} = 1 for @{ $self->order->items_sorted };
1537 title => $self->get_title_for('edit'),
1538 %{$self->{template_args}}
1542 sub workflow_sales_or_purchase_order {
1546 my $errors = $self->save();
1548 if (scalar @{ $errors }) {
1549 $self->js->flash('error', $_) foreach @{ $errors };
1550 return $self->js->render();
1553 my $destination_type = $::form->{type} eq sales_quotation_type() ? sales_order_type()
1554 : $::form->{type} eq request_quotation_type() ? purchase_order_type()
1555 : $::form->{type} eq purchase_order_type() ? sales_order_type()
1556 : $::form->{type} eq sales_order_type() ? purchase_order_type()
1559 # check for direct delivery
1560 # copy shipto in custom shipto (custom shipto will be copied by new_from() in case)
1562 if ( $::form->{type} eq sales_order_type() && $destination_type eq purchase_order_type()
1563 && $::form->{use_shipto} && $self->order->shipto) {
1564 $custom_shipto = $self->order->shipto->clone('SL::DB::Order');
1567 $self->order(SL::DB::Order->new_from($self->order, destination_type => $destination_type));
1568 $self->{converted_from_oe_id} = delete $::form->{id};
1570 # set item ids to new fake id, to identify them as new items
1571 foreach my $item (@{$self->order->items_sorted}) {
1572 $item->{new_fake_id} = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
1575 if ($::form->{type} eq sales_order_type() && $destination_type eq purchase_order_type()) {
1576 if ($::form->{use_shipto}) {
1577 $self->order->custom_shipto($custom_shipto) if $custom_shipto;
1579 # remove any custom shipto if not wanted
1580 $self->order->custom_shipto(SL::DB::Shipto->new(module => 'OE', custom_variables => []));
1585 $::form->{type} = $destination_type;
1586 $self->type($self->init_type);
1587 $self->cv ($self->init_cv);
1590 $self->get_unalterable_data();
1591 $self->pre_render();
1593 # trigger rendering values for second row as hidden, because they
1594 # are loaded only on demand. So we need to keep the values from the
1596 $_->{render_second_row} = 1 for @{ $self->order->items_sorted };
1600 title => $self->get_title_for('edit'),
1601 %{$self->{template_args}}
1609 $self->{all_taxzones} = SL::DB::Manager::TaxZone->get_all_sorted();
1610 $self->{all_currencies} = SL::DB::Manager::Currency->get_all_sorted();
1611 $self->{all_departments} = SL::DB::Manager::Department->get_all_sorted();
1612 $self->{all_languages} = SL::DB::Manager::Language->get_all_sorted();
1613 $self->{all_employees} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->employee_id,
1616 $self->{all_salesmen} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->salesman_id,
1619 $self->{all_payment_terms} = SL::DB::Manager::PaymentTerm->get_all_sorted(where => [ or => [ id => $self->order->payment_id,
1621 $self->{all_delivery_terms} = SL::DB::Manager::DeliveryTerm->get_all_sorted();
1622 $self->{current_employee_id} = SL::DB::Manager::Employee->current->id;
1623 $self->{order_probabilities} = [ map { { title => ($_ * 10) . '%', id => $_ * 10 } } (0..10) ];
1624 $self->{positions_scrollbar_height} = SL::Helper::UserPreferences::PositionsScrollbar->new()->get_height();
1626 my $print_form = Form->new('');
1627 $print_form->{type} = $self->type;
1628 $print_form->{printers} = SL::DB::Manager::Printer->get_all_sorted;
1629 $self->{print_options} = SL::Helper::PrintOptions->get_print_options(
1630 form => $print_form,
1631 options => {dialog_name_prefix => 'print_options.',
1635 no_opendocument => 0,
1639 foreach my $item (@{$self->order->orderitems}) {
1640 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
1641 $item->active_price_source( $price_source->price_from_source( $item->active_price_source ));
1642 $item->active_discount_source($price_source->discount_from_source($item->active_discount_source));
1645 if (any { $self->type eq $_ } (sales_order_type(), purchase_order_type())) {
1646 # Calculate shipped qtys here to prevent calling calculate for every item via the items method.
1647 # Do not use write_to_objects to prevent order->delivered to be set, because this should be
1648 # the value from db, which can be set manually or is set when linked delivery orders are saved.
1649 SL::Helper::ShippedQty->new->calculate($self->order)->write_to(\@{$self->order->items});
1652 if ($self->order->number && $::instance_conf->get_webdav) {
1653 my $webdav = SL::Webdav->new(
1654 type => $self->type,
1655 number => $self->order->number,
1657 my @all_objects = $webdav->get_all_objects;
1658 @{ $self->{template_args}->{WEBDAV} } = map { { name => $_->filename,
1660 link => File::Spec->catfile($_->full_filedescriptor),
1664 $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
1666 $::request->{layout}->use_javascript("${_}.js") for qw(kivi.SalesPurchase kivi.Order kivi.File ckeditor/ckeditor ckeditor/adapters/jquery
1667 calculate_qty kivi.Validator follow_up show_history);
1668 $self->setup_edit_action_bar;
1671 sub setup_edit_action_bar {
1672 my ($self, %params) = @_;
1674 my $deletion_allowed = (any { $self->type eq $_ } (sales_quotation_type(), request_quotation_type()))
1675 || (($self->type eq sales_order_type()) && $::instance_conf->get_sales_order_show_delete)
1676 || (($self->type eq purchase_order_type()) && $::instance_conf->get_purchase_order_show_delete);
1678 for my $bar ($::request->layout->get('actionbar')) {
1683 call => [ 'kivi.Order.save', 'save', $::instance_conf->get_order_warn_duplicate_parts,
1684 $::instance_conf->get_order_warn_no_deliverydate,
1689 call => [ 'kivi.Order.save', 'save_as_new', $::instance_conf->get_order_warn_duplicate_parts ],
1690 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1692 ], # end of combobox "Save"
1699 t8('Save and Quotation'),
1700 submit => [ '#order_form', { action => "Order/sales_quotation" } ],
1701 only_if => (any { $self->type eq $_ } (sales_order_type())),
1705 submit => [ '#order_form', { action => "Order/request_for_quotation" } ],
1706 only_if => (any { $self->type eq $_ } (purchase_order_type())),
1709 t8('Save and Sales Order'),
1710 submit => [ '#order_form', { action => "Order/sales_order" } ],
1711 only_if => (any { $self->type eq $_ } (sales_quotation_type(), purchase_order_type())),
1714 t8('Save and Purchase Order'),
1715 call => [ 'kivi.Order.purchase_order_check_for_direct_delivery' ],
1716 only_if => (any { $self->type eq $_ } (sales_order_type(), request_quotation_type())),
1719 t8('Save and Delivery Order'),
1720 call => [ 'kivi.Order.save', 'save_and_delivery_order', $::instance_conf->get_order_warn_duplicate_parts,
1721 $::instance_conf->get_order_warn_no_deliverydate,
1723 only_if => (any { $self->type eq $_ } (sales_order_type(), purchase_order_type()))
1726 t8('Save and Invoice'),
1727 call => [ 'kivi.Order.save', 'save_and_invoice', $::instance_conf->get_order_warn_duplicate_parts ],
1730 t8('Save and AP Transaction'),
1731 call => [ 'kivi.Order.save', 'save_and_ap_transaction', $::instance_conf->get_order_warn_duplicate_parts ],
1732 only_if => (any { $self->type eq $_ } (purchase_order_type()))
1735 ], # end of combobox "Workflow"
1742 t8('Save and preview PDF'),
1743 call => [ 'kivi.Order.save', 'preview_pdf', $::instance_conf->get_order_warn_duplicate_parts,
1744 $::instance_conf->get_order_warn_no_deliverydate,
1748 t8('Save and print'),
1749 call => [ 'kivi.Order.show_print_options', $::instance_conf->get_order_warn_duplicate_parts,
1750 $::instance_conf->get_order_warn_no_deliverydate,
1754 t8('Save and E-mail'),
1755 id => 'save_and_email_action',
1756 call => [ 'kivi.Order.save', 'save_and_show_email_dialog', $::instance_conf->get_order_warn_duplicate_parts,
1757 $::instance_conf->get_order_warn_no_deliverydate,
1759 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1762 t8('Download attachments of all parts'),
1763 call => [ 'kivi.File.downloadOrderitemsFiles', $::form->{type}, $::form->{id} ],
1764 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1765 only_if => $::instance_conf->get_doc_storage,
1767 ], # end of combobox "Export"
1771 call => [ 'kivi.Order.delete_order' ],
1772 confirm => $::locale->text('Do you really want to delete this object?'),
1773 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1774 only_if => $deletion_allowed,
1783 call => [ 'kivi.Order.follow_up_window' ],
1784 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1785 only_if => $::auth->assert('productivity', 1),
1789 call => [ 'set_history_window', $self->order->id, 'id' ],
1790 disabled => !$self->order->id ? t8('This record has not been saved yet.') : undef,
1792 ], # end of combobox "more"
1798 my ($order, $pdf_ref, $params) = @_;
1802 my $print_form = Form->new('');
1803 $print_form->{type} = $order->type;
1804 $print_form->{formname} = $params->{formname} || $order->type;
1805 $print_form->{format} = $params->{format} || 'pdf';
1806 $print_form->{media} = $params->{media} || 'file';
1807 $print_form->{groupitems} = $params->{groupitems};
1808 $print_form->{printer_id} = $params->{printer_id};
1809 $print_form->{media} = 'file' if $print_form->{media} eq 'screen';
1811 $order->language($params->{language});
1812 $order->flatten_to_form($print_form, format_amounts => 1);
1816 if ($print_form->{format} =~ /(opendocument|oasis)/i) {
1817 $template_ext = 'odt';
1818 $template_type = 'OpenDocument';
1821 # search for the template
1822 my ($template_file, @template_files) = SL::Helper::CreatePDF->find_template(
1823 name => $print_form->{formname},
1824 extension => $template_ext,
1825 email => $print_form->{media} eq 'email',
1826 language => $params->{language},
1827 printer_id => $print_form->{printer_id},
1830 if (!defined $template_file) {
1831 push @errors, $::locale->text('Cannot find matching template for this print request. Please contact your template maintainer. I tried these: #1.', join ', ', map { "'$_'"} @template_files);
1834 return @errors if scalar @errors;
1836 $print_form->throw_on_error(sub {
1838 $print_form->prepare_for_printing;
1840 $$pdf_ref = SL::Helper::CreatePDF->create_pdf(
1841 format => $print_form->{format},
1842 template_type => $template_type,
1843 template => $template_file,
1844 variables => $print_form,
1845 variable_content_types => {
1846 longdescription => 'html',
1847 partnotes => 'html',
1852 } || push @errors, ref($EVAL_ERROR) eq 'SL::X::FormError' ? $EVAL_ERROR->error : $EVAL_ERROR;
1858 sub get_files_for_email_dialog {
1861 my %files = map { ($_ => []) } qw(versions files vc_files part_files);
1863 return %files if !$::instance_conf->get_doc_storage;
1865 if ($self->order->id) {
1866 $files{versions} = [ SL::File->get_all_versions(object_id => $self->order->id, object_type => $self->order->type, file_type => 'document') ];
1867 $files{files} = [ SL::File->get_all( object_id => $self->order->id, object_type => $self->order->type, file_type => 'attachment') ];
1868 $files{vc_files} = [ SL::File->get_all( object_id => $self->order->{$self->cv}->id, object_type => $self->cv, file_type => 'attachment') ];
1869 $files{project_files} = [ SL::File->get_all( object_id => $self->order->globalproject_id, object_type => 'project', file_type => 'attachment') ];
1873 uniq_by { $_->{id} }
1875 +{ id => $_->part->id,
1876 partnumber => $_->part->partnumber }
1877 } @{$self->order->items_sorted};
1879 foreach my $part (@parts) {
1880 my @pfiles = SL::File->get_all(object_id => $part->{id}, object_type => 'part');
1881 push @{ $files{part_files} }, map { +{ %{ $_ }, partnumber => $part->{partnumber} } } @pfiles;
1884 foreach my $key (keys %files) {
1885 $files{$key} = [ sort_by { lc $_->{db_file}->{file_name} } @{ $files{$key} } ];
1892 my ($self, $action) = @_;
1894 return '' if none { lc($action)} qw(add edit);
1897 # $::locale->text("Add Sales Order");
1898 # $::locale->text("Add Purchase Order");
1899 # $::locale->text("Add Quotation");
1900 # $::locale->text("Add Request for Quotation");
1901 # $::locale->text("Edit Sales Order");
1902 # $::locale->text("Edit Purchase Order");
1903 # $::locale->text("Edit Quotation");
1904 # $::locale->text("Edit Request for Quotation");
1906 $action = ucfirst(lc($action));
1907 return $self->type eq sales_order_type() ? $::locale->text("$action Sales Order")
1908 : $self->type eq purchase_order_type() ? $::locale->text("$action Purchase Order")
1909 : $self->type eq sales_quotation_type() ? $::locale->text("$action Quotation")
1910 : $self->type eq request_quotation_type() ? $::locale->text("$action Request for Quotation")
1914 sub get_item_cvpartnumber {
1915 my ($self, $item) = @_;
1917 return if !$self->search_cvpartnumber;
1918 return if !$self->order->customervendor;
1920 if ($self->cv eq 'vendor') {
1921 my @mms = grep { $_->make eq $self->order->customervendor->id } @{$item->part->makemodels};
1922 $item->{cvpartnumber} = $mms[0]->model if scalar @mms;
1923 } elsif ($self->cv eq 'customer') {
1924 my @cps = grep { $_->customer_id eq $self->order->customervendor->id } @{$item->part->customerprices};
1925 $item->{cvpartnumber} = $cps[0]->customer_partnumber if scalar @cps;
1929 sub get_part_texts {
1930 my ($part_or_id, $language_or_id, %defaults) = @_;
1932 my $part = ref($part_or_id) ? $part_or_id : SL::DB::Part->load_cached($part_or_id);
1933 my $language_id = ref($language_or_id) ? $language_or_id->id : $language_or_id;
1935 description => $defaults{description} // $part->description,
1936 longdescription => $defaults{longdescription} // $part->notes,
1939 return $texts unless $language_id;
1941 my $translation = SL::DB::Manager::Translation->get_first(
1943 parts_id => $part->id,
1944 language_id => $language_id,
1947 $texts->{description} = $translation->translation if $translation && $translation->translation;
1948 $texts->{longdescription} = $translation->longdescription if $translation && $translation->longdescription;
1953 sub sales_order_type {
1957 sub purchase_order_type {
1961 sub sales_quotation_type {
1965 sub request_quotation_type {
1966 'request_quotation';
1970 return $_[0]->type eq sales_order_type() ? 'ordnumber'
1971 : $_[0]->type eq purchase_order_type() ? 'ordnumber'
1972 : $_[0]->type eq sales_quotation_type() ? 'quonumber'
1973 : $_[0]->type eq request_quotation_type() ? 'quonumber'
1977 sub save_and_redirect_to {
1978 my ($self, %params) = @_;
1980 my $errors = $self->save();
1982 if (scalar @{ $errors }) {
1983 $self->js->flash('error', $_) foreach @{ $errors };
1984 return $self->js->render();
1987 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
1988 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
1989 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
1990 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
1992 flash_later('info', $text);
1994 $self->redirect_to(%params, id => $self->order->id);
1998 my ($self, $addition) = @_;
2000 my $number_type = $self->order->type =~ m{order} ? 'ordnumber' : 'quonumber';
2001 my $snumbers = $number_type . '_' . $self->order->$number_type;
2003 SL::DB::History->new(
2004 trans_id => $self->order->id,
2005 employee_id => SL::DB::Manager::Employee->current->id,
2006 what_done => $self->order->type,
2007 snumbers => $snumbers,
2008 addition => $addition,
2012 sub store_pdf_to_webdav_and_filemanagement {
2013 my($order, $content, $filename) = @_;
2017 # copy file to webdav folder
2018 if ($order->number && $::instance_conf->get_webdav_documents) {
2019 my $webdav = SL::Webdav->new(
2020 type => $order->type,
2021 number => $order->number,
2023 my $webdav_file = SL::Webdav::File->new(
2025 filename => $filename,
2028 $webdav_file->store(data => \$content);
2031 push @errors, t8('Storing PDF to webdav folder failed: #1', $@);
2034 if ($order->id && $::instance_conf->get_doc_storage) {
2036 SL::File->save(object_id => $order->id,
2037 object_type => $order->type,
2038 mime_type => 'application/pdf',
2039 source => 'created',
2040 file_type => 'document',
2041 file_name => $filename,
2042 file_contents => $content);
2045 push @errors, t8('Storing PDF in storage backend failed: #1', $@);
2060 SL::Controller::Order - controller for orders
2064 This is a new form to enter orders, completely rewritten with the use
2065 of controller and java script techniques.
2067 The aim is to provide the user a better experience and a faster workflow. Also
2068 the code should be more readable, more reliable and better to maintain.
2076 One input row, so that input happens every time at the same place.
2080 Use of pickers where possible.
2084 Possibility to enter more than one item at once.
2088 Item list in a scrollable area, so that the workflow buttons stay at
2093 Reordering item rows with drag and drop is possible. Sorting item rows is
2094 possible (by partnumber, description, qty, sellprice and discount for now).
2098 No C<update> is necessary. All entries and calculations are managed
2099 with ajax-calls and the page only reloads on C<save>.
2103 User can see changes immediately, because of the use of java script
2114 =item * C<SL/Controller/Order.pm>
2118 =item * C<template/webpages/order/form.html>
2122 =item * C<template/webpages/order/tabs/basic_data.html>
2124 Main tab for basic_data.
2126 This is the only tab here for now. "linked records" and "webdav" tabs are
2127 reused from generic code.
2131 =item * C<template/webpages/order/tabs/_business_info_row.html>
2133 For displaying information on business type
2135 =item * C<template/webpages/order/tabs/_item_input.html>
2137 The input line for items
2139 =item * C<template/webpages/order/tabs/_row.html>
2141 One row for already entered items
2143 =item * C<template/webpages/order/tabs/_tax_row.html>
2145 Displaying tax information
2147 =item * C<template/webpages/order/tabs/_price_sources_dialog.html>
2149 Dialog for selecting price and discount sources
2153 =item * C<js/kivi.Order.js>
2155 java script functions
2165 =item * price sources: little symbols showing better price / better discount
2167 =item * select units in input row?
2169 =item * check for direct delivery (workflow sales order -> purchase order)
2171 =item * access rights
2173 =item * display weights
2177 =item * optional client/user behaviour
2179 (transactions has to be set - department has to be set -
2180 force project if enabled in client config - transport cost reminder)
2184 =head1 KNOWN BUGS AND CAVEATS
2190 Customer discount is not displayed as a valid discount in price source popup
2191 (this might be a bug in price sources)
2193 (I cannot reproduce this (Bernd))
2197 No indication that <shift>-up/down expands/collapses second row.
2201 Inline creation of parts is not currently supported
2205 Table header is not sticky in the scrolling area.
2209 Sorting does not include C<position>, neither does reordering.
2211 This behavior was implemented intentionally. But we can discuss, which behavior
2212 should be implemented.
2216 =head1 To discuss / Nice to have
2222 How to expand/collapse second row. Now it can be done clicking the icon or
2227 Possibility to select PriceSources in input row?
2231 This controller uses a (changed) copy of the template for the PriceSource
2232 dialog. Maybe there could be used one code source.
2236 Rounding-differences between this controller (PriceTaxCalculator) and the old
2237 form. This is not only a problem here, but also in all parts using the PTC.
2238 There exists a ticket and a patch. This patch should be testet.
2242 An indicator, if the actual inputs are saved (like in an
2243 editor or on text processing application).
2247 A warning when leaving the page without saveing unchanged inputs.
2254 Bernd Bleßmann E<lt>bernd@kivitendo-premium.deE<gt>