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);
8 use SL::Locale::String qw(t8);
9 use SL::SessionFile::Random;
13 use SL::Util qw(trim);
18 use SL::DB::PartsGroup;
21 use SL::DB::RecordLink;
23 use SL::Helper::CreatePDF qw(:all);
24 use SL::Helper::PrintOptions;
25 use SL::Helper::ShippedQty;
27 use SL::Controller::Helper::GetModels;
29 use List::Util qw(first);
30 use List::UtilsBy qw(sort_by uniq_by);
31 use List::MoreUtils qw(any none pairwise first_index);
32 use English qw(-no_match_vars);
36 use Rose::Object::MakeMethods::Generic
38 scalar => [ qw(item_ids_to_delete) ],
39 'scalar --get_set_init' => [ qw(order valid_types type cv p multi_items_models all_price_factors) ],
44 __PACKAGE__->run_before('check_auth');
46 __PACKAGE__->run_before('recalc',
47 only => [ qw(save save_as_new save_and_delivery_order save_and_invoice print send_email) ]);
49 __PACKAGE__->run_before('get_unalterable_data',
50 only => [ qw(save save_as_new save_and_delivery_order save_and_invoice print send_email) ]);
60 $self->order->transdate(DateTime->now_local());
61 my $extra_days = $self->type eq sales_quotation_type() ? $::instance_conf->get_reqdate_interval : 1;
62 $self->order->reqdate(DateTime->today_local->next_workday(extra_days => $extra_days)) if !$self->order->reqdate;
67 title => $self->get_title_for('add'),
68 %{$self->{template_args}}
72 # edit an existing order
80 # this is to edit an order from an unsaved order object
82 # set item ids to new fake id, to identify them as new items
83 foreach my $item (@{$self->order->items_sorted}) {
84 $item->{new_fake_id} = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
86 # trigger rendering values for second row/longdescription as hidden,
87 # because they are loaded only on demand. So we need to keep the values
89 $_->{render_second_row} = 1 for @{ $self->order->items_sorted };
90 $_->{render_longdescription} = 1 for @{ $self->order->items_sorted };
97 title => $self->get_title_for('edit'),
98 %{$self->{template_args}}
106 my $errors = $self->delete();
108 if (scalar @{ $errors }) {
109 $self->js->flash('error', $_) foreach @{ $errors };
110 return $self->js->render();
113 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been deleted')
114 : $self->type eq purchase_order_type() ? $::locale->text('The order has been deleted')
115 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been deleted')
116 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been deleted')
118 flash_later('info', $text);
120 my @redirect_params = (
125 $self->redirect_to(@redirect_params);
132 my $errors = $self->save();
134 if (scalar @{ $errors }) {
135 $self->js->flash('error', $_) foreach @{ $errors };
136 return $self->js->render();
139 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
140 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
141 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
142 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
144 flash_later('info', $text);
146 my @redirect_params = (
149 id => $self->order->id,
152 $self->redirect_to(@redirect_params);
155 # save the order as new document an open it for edit
156 sub action_save_as_new {
159 my $order = $self->order;
162 $self->js->flash('error', t8('This object has not been saved yet.'));
163 return $self->js->render();
166 # load order from db to check if values changed
167 my $saved_order = SL::DB::Order->new(id => $order->id)->load;
170 # Lets assign a new number if the user hasn't changed the previous one.
171 # If it has been changed manually then use it as-is.
172 $new_attrs{number} = (trim($order->number) eq $saved_order->number)
174 : trim($order->number);
176 # Clear transdate unless changed
177 $new_attrs{transdate} = ($order->transdate == $saved_order->transdate)
178 ? DateTime->today_local
181 # Set new reqdate unless changed
182 if ($order->reqdate == $saved_order->reqdate) {
183 my $extra_days = $self->type eq sales_quotation_type() ? $::instance_conf->get_reqdate_interval : 1;
184 $new_attrs{reqdate} = DateTime->today_local->next_workday(extra_days => $extra_days);
186 $new_attrs{reqdate} = $order->reqdate;
190 $new_attrs{employee} = SL::DB::Manager::Employee->current;
192 # Create new record from current one
193 $self->order(SL::DB::Order->new_from($order, destination_type => $order->type, attributes => \%new_attrs));
195 # no linked records on save as new
196 delete $::form->{$_} for qw(converted_from_oe_id converted_from_orderitems_ids);
199 $self->action_save();
204 # This is called if "print" is pressed in the print dialog.
205 # If PDF creation was requested and succeeded, the pdf is stored in a session
206 # file and the filename is stored as session value with an unique key. A
207 # javascript function with this key is then called. This function calls the
208 # download action below (action_download_pdf), which offers the file for
213 my $format = $::form->{print_options}->{format};
214 my $media = $::form->{print_options}->{media};
215 my $formname = $::form->{print_options}->{formname};
216 my $copies = $::form->{print_options}->{copies};
217 my $groupitems = $::form->{print_options}->{groupitems};
219 # only pdf and opendocument by now
220 if (none { $format eq $_ } qw(pdf opendocument opendocument_pdf)) {
221 return $self->js->flash('error', t8('Format \'#1\' is not supported yet/anymore.', $format))->render;
224 # only screen or printer by now
225 if (none { $media eq $_ } qw(screen printer)) {
226 return $self->js->flash('error', t8('Media \'#1\' is not supported yet/anymore.', $media))->render;
230 $language = SL::DB::Language->new(id => $::form->{print_options}->{language_id})->load if $::form->{print_options}->{language_id};
232 # create a form for generate_attachment_filename
233 my $form = Form->new;
234 $form->{$self->nr_key()} = $self->order->number;
235 $form->{type} = $self->type;
236 $form->{format} = $format;
237 $form->{formname} = $formname;
238 $form->{language} = '_' . $language->template_code if $language;
239 my $pdf_filename = $form->generate_attachment_filename();
242 my @errors = generate_pdf($self->order, \$pdf, { format => $format,
243 formname => $formname,
244 language => $language,
245 groupitems => $groupitems });
246 if (scalar @errors) {
247 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render;
250 if ($media eq 'screen') {
252 my $sfile = SL::SessionFile::Random->new(mode => "w");
253 $sfile->fh->print($pdf);
256 my $key = join('_', Time::HiRes::gettimeofday(), int rand 1000000000000);
257 $::auth->set_session_value("Order::print-${key}" => $sfile->file_name);
260 ->run('kivi.Order.download_pdf', $pdf_filename, $key)
261 ->flash('info', t8('The PDF has been created'));
263 } elsif ($media eq 'printer') {
265 my $printer_id = $::form->{print_options}->{printer_id};
266 SL::DB::Printer->new(id => $printer_id)->load->print_document(
271 $self->js->flash('info', t8('The PDF has been printed'));
274 # copy file to webdav folder
275 if ($self->order->number && $::instance_conf->get_webdav_documents) {
276 my $webdav = SL::Webdav->new(
278 number => $self->order->number,
280 my $webdav_file = SL::Webdav::File->new(
282 filename => $pdf_filename,
285 $webdav_file->store(data => \$pdf);
288 $self->js->flash('error', t8('Storing PDF to webdav folder failed: #1', $@));
291 if ($self->order->number && $::instance_conf->get_doc_storage) {
293 SL::File->save(object_id => $self->order->id,
294 object_type => $self->type,
295 mime_type => 'application/pdf',
297 file_type => 'document',
298 file_name => $pdf_filename,
299 file_contents => $pdf);
302 $self->js->flash('error', t8('Storing PDF in storage backend failed: #1', $@));
308 # offer pdf for download
310 # It needs to get the key for the session value to get the pdf file.
311 sub action_download_pdf {
314 my $key = $::form->{key};
315 my $tmp_filename = $::auth->get_session_value("Order::print-${key}");
316 return $self->send_file(
318 type => 'application/pdf',
319 name => $::form->{pdf_filename},
323 # open the email dialog
324 sub action_show_email_dialog {
327 my $cv_method = $self->cv;
329 if (!$self->order->$cv_method) {
330 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'))
335 $email_form->{to} = $self->order->contact->cp_email if $self->order->contact;
336 $email_form->{to} ||= $self->order->$cv_method->email;
337 $email_form->{cc} = $self->order->$cv_method->cc;
338 $email_form->{bcc} = join ', ', grep $_, $self->order->$cv_method->bcc, SL::DB::Default->get->global_bcc;
339 # Todo: get addresses from shipto, if any
341 my $form = Form->new;
342 $form->{$self->nr_key()} = $self->order->number;
343 $form->{formname} = $self->type;
344 $form->{type} = $self->type;
345 $form->{language} = 'de';
346 $form->{format} = 'pdf';
348 $email_form->{subject} = $form->generate_email_subject();
349 $email_form->{attachment_filename} = $form->generate_attachment_filename();
350 $email_form->{message} = $form->generate_email_body();
351 $email_form->{js_send_function} = 'kivi.Order.send_email()';
353 my %files = $self->get_files_for_email_dialog();
354 my $dialog_html = $self->render('common/_send_email_dialog', { output => 0 },
355 email_form => $email_form,
356 show_bcc => $::auth->assert('email_bcc', 'may fail'),
358 is_customer => $self->cv eq 'customer',
362 ->run('kivi.Order.show_email_dialog', $dialog_html)
369 # Todo: handling error messages: flash is not displayed in dialog, but in the main form
370 sub action_send_email {
373 my $email_form = delete $::form->{email_form};
374 my %field_names = (to => 'email');
376 $::form->{ $field_names{$_} // $_ } = $email_form->{$_} for keys %{ $email_form };
378 # for Form::cleanup which may be called in Form::send_email
379 $::form->{cwd} = getcwd();
380 $::form->{tmpdir} = $::lx_office_conf{paths}->{userspath};
382 $::form->{$_} = $::form->{print_options}->{$_} for keys %{ $::form->{print_options} };
383 $::form->{media} = 'email';
385 if (($::form->{attachment_policy} // '') !~ m{^(?:old_file|no_file)$}) {
387 $language = SL::DB::Language->new(id => $::form->{print_options}->{language_id})->load if $::form->{print_options}->{language_id};
390 my @errors = generate_pdf($self->order, \$pdf, {media => $::form->{media},
391 format => $::form->{print_options}->{format},
392 formname => $::form->{print_options}->{formname},
393 language => $language,
394 groupitems => $::form->{print_options}->{groupitems}});
395 if (scalar @errors) {
396 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
399 my $sfile = SL::SessionFile::Random->new(mode => "w");
400 $sfile->fh->print($pdf);
403 $::form->{tmpfile} = $sfile->file_name;
404 $::form->{tmpdir} = $sfile->get_path; # for Form::cleanup which may be called in Form::send_email
407 $::form->send_email(\%::myconfig, 'pdf');
410 my $intnotes = $self->order->intnotes;
411 $intnotes .= "\n\n" if $self->order->intnotes;
412 $intnotes .= t8('[email]') . "\n";
413 $intnotes .= t8('Date') . ": " . $::locale->format_date_object(DateTime->now_local, precision => 'seconds') . "\n";
414 $intnotes .= t8('To (email)') . ": " . $::form->{email} . "\n";
415 $intnotes .= t8('Cc') . ": " . $::form->{cc} . "\n" if $::form->{cc};
416 $intnotes .= t8('Bcc') . ": " . $::form->{bcc} . "\n" if $::form->{bcc};
417 $intnotes .= t8('Subject') . ": " . $::form->{subject} . "\n\n";
418 $intnotes .= t8('Message') . ": " . $::form->{message};
421 ->val('#order_intnotes', $intnotes)
422 ->run('kivi.Order.close_email_dialog')
423 ->flash('info', t8('The email has been sent.'))
427 # open the periodic invoices config dialog
429 # If there are values in the form (i.e. dialog was opened before),
430 # then use this values. Create new ones, else.
431 sub action_show_periodic_invoices_config_dialog {
434 my $config = make_periodic_invoices_config_from_yaml(delete $::form->{config});
435 $config ||= SL::DB::Manager::PeriodicInvoicesConfig->find_by(oe_id => $::form->{id}) if $::form->{id};
436 $config ||= SL::DB::PeriodicInvoicesConfig->new(periodicity => 'm',
437 order_value_periodicity => 'p', # = same as periodicity
438 start_date_as_date => $::form->{transdate} || $::form->current_date,
439 extend_automatically_by => 12,
441 email_subject => GenericTranslations->get(
442 language_id => $::form->{language_id},
443 translation_type =>"preset_text_periodic_invoices_email_subject"),
444 email_body => GenericTranslations->get(
445 language_id => $::form->{language_id},
446 translation_type =>"preset_text_periodic_invoices_email_body"),
448 $config->periodicity('m') if none { $_ eq $config->periodicity } @SL::DB::PeriodicInvoicesConfig::PERIODICITIES;
449 $config->order_value_periodicity('p') if none { $_ eq $config->order_value_periodicity } ('p', @SL::DB::PeriodicInvoicesConfig::ORDER_VALUE_PERIODICITIES);
451 $::form->get_lists(printers => "ALL_PRINTERS",
452 charts => { key => 'ALL_CHARTS',
453 transdate => 'current_date' });
455 $::form->{AR} = [ grep { $_->{link} =~ m/(?:^|:)AR(?::|$)/ } @{ $::form->{ALL_CHARTS} } ];
457 if ($::form->{customer_id}) {
458 $::form->{ALL_CONTACTS} = SL::DB::Manager::Contact->get_all_sorted(where => [ cp_cv_id => $::form->{customer_id} ]);
461 $self->render('oe/edit_periodic_invoices_config', { layout => 0 },
463 popup_js_close_function => 'kivi.Order.close_periodic_invoices_config_dialog()',
464 popup_js_assign_function => 'kivi.Order.assign_periodic_invoices_config()',
469 # assign the values of the periodic invoices config dialog
470 # as yaml in the hidden tag and set the status.
471 sub action_assign_periodic_invoices_config {
474 $::form->isblank('start_date_as_date', $::locale->text('The start date is missing.'));
476 my $config = { active => $::form->{active} ? 1 : 0,
477 terminated => $::form->{terminated} ? 1 : 0,
478 direct_debit => $::form->{direct_debit} ? 1 : 0,
479 periodicity => (any { $_ eq $::form->{periodicity} } @SL::DB::PeriodicInvoicesConfig::PERIODICITIES) ? $::form->{periodicity} : 'm',
480 order_value_periodicity => (any { $_ eq $::form->{order_value_periodicity} } ('p', @SL::DB::PeriodicInvoicesConfig::ORDER_VALUE_PERIODICITIES)) ? $::form->{order_value_periodicity} : 'p',
481 start_date_as_date => $::form->{start_date_as_date},
482 end_date_as_date => $::form->{end_date_as_date},
483 first_billing_date_as_date => $::form->{first_billing_date_as_date},
484 print => $::form->{print} ? 1 : 0,
485 printer_id => $::form->{print} ? $::form->{printer_id} * 1 : undef,
486 copies => $::form->{copies} * 1 ? $::form->{copies} : 1,
487 extend_automatically_by => $::form->{extend_automatically_by} * 1 || undef,
488 ar_chart_id => $::form->{ar_chart_id} * 1,
489 send_email => $::form->{send_email} ? 1 : 0,
490 email_recipient_contact_id => $::form->{email_recipient_contact_id} * 1 || undef,
491 email_recipient_address => $::form->{email_recipient_address},
492 email_sender => $::form->{email_sender},
493 email_subject => $::form->{email_subject},
494 email_body => $::form->{email_body},
497 my $periodic_invoices_config = YAML::Dump($config);
499 my $status = $self->get_periodic_invoices_status($config);
502 ->remove('#order_periodic_invoices_config')
503 ->insertAfter(hidden_tag('order.periodic_invoices_config', $periodic_invoices_config), '#periodic_invoices_status')
504 ->run('kivi.Order.close_periodic_invoices_config_dialog')
505 ->html('#periodic_invoices_status', $status)
506 ->flash('info', t8('The periodic invoices config has been assigned.'))
510 sub action_get_has_active_periodic_invoices {
513 my $config = make_periodic_invoices_config_from_yaml(delete $::form->{config});
514 $config ||= SL::DB::Manager::PeriodicInvoicesConfig->find_by(oe_id => $::form->{id}) if $::form->{id};
516 my $has_active_periodic_invoices =
517 $self->type eq sales_order_type()
520 && (!$config->end_date || ($config->end_date > DateTime->today_local))
521 && $config->get_previous_billed_period_start_date;
523 $_[0]->render(\ !!$has_active_periodic_invoices, { type => 'text' });
526 # save the order and redirect to the frontend subroutine for a new
528 sub action_save_and_delivery_order {
531 my $errors = $self->save();
533 if (scalar @{ $errors }) {
534 $self->js->flash('error', $_) foreach @{ $errors };
535 return $self->js->render();
538 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
539 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
540 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
541 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
543 flash_later('info', $text);
545 my @redirect_params = (
546 controller => 'oe.pl',
547 action => 'oe_delivery_order_from_order',
548 id => $self->order->id,
551 $self->redirect_to(@redirect_params);
554 # save the order and redirect to the frontend subroutine for a new
556 sub action_save_and_invoice {
559 my $errors = $self->save();
561 if (scalar @{ $errors }) {
562 $self->js->flash('error', $_) foreach @{ $errors };
563 return $self->js->render();
566 my $text = $self->type eq sales_order_type() ? $::locale->text('The order has been saved')
567 : $self->type eq purchase_order_type() ? $::locale->text('The order has been saved')
568 : $self->type eq sales_quotation_type() ? $::locale->text('The quotation has been saved')
569 : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
571 flash_later('info', $text);
573 my @redirect_params = (
574 controller => 'oe.pl',
575 action => 'oe_invoice_from_order',
576 id => $self->order->id,
579 $self->redirect_to(@redirect_params);
582 # workflow from sales quotation to sales order
583 sub action_sales_order {
584 $_[0]->workflow_sales_or_purchase_order();
587 # workflow from rfq to purchase order
588 sub action_purchase_order {
589 $_[0]->workflow_sales_or_purchase_order();
592 # set form elements in respect to a changed customer or vendor
594 # This action is called on an change of the customer/vendor picker.
595 sub action_customer_vendor_changed {
598 setup_order_from_cv($self->order);
601 my $cv_method = $self->cv;
603 if ($self->order->$cv_method->contacts && scalar @{ $self->order->$cv_method->contacts } > 0) {
604 $self->js->show('#cp_row');
606 $self->js->hide('#cp_row');
609 if ($self->order->$cv_method->shipto && scalar @{ $self->order->$cv_method->shipto } > 0) {
610 $self->js->show('#shipto_row');
612 $self->js->hide('#shipto_row');
615 $self->js->val( '#order_salesman_id', $self->order->salesman_id) if $self->order->is_sales;
618 ->replaceWith('#order_cp_id', $self->build_contact_select)
619 ->replaceWith('#order_shipto_id', $self->build_shipto_select)
620 ->replaceWith('#business_info_row', $self->build_business_info_row)
621 ->val( '#order_taxzone_id', $self->order->taxzone_id)
622 ->val( '#order_taxincluded', $self->order->taxincluded)
623 ->val( '#order_payment_id', $self->order->payment_id)
624 ->val( '#order_delivery_term_id', $self->order->delivery_term_id)
625 ->val( '#order_intnotes', $self->order->intnotes)
626 ->focus( '#order_' . $self->cv . '_id');
628 $self->js_redisplay_amounts_and_taxes;
632 # open the dialog for customer/vendor details
633 sub action_show_customer_vendor_details_dialog {
636 my $is_customer = 'customer' eq $::form->{vc};
639 $cv = SL::DB::Customer->new(id => $::form->{vc_id})->load;
641 $cv = SL::DB::Vendor->new(id => $::form->{vc_id})->load;
644 my %details = map { $_ => $cv->$_ } @{$cv->meta->columns};
645 $details{discount_as_percent} = $cv->discount_as_percent;
646 $details{creditlimt} = $cv->creditlimit_as_number;
647 $details{business} = $cv->business->description if $cv->business;
648 $details{language} = $cv->language_obj->description if $cv->language_obj;
649 $details{delivery_terms} = $cv->delivery_term->description if $cv->delivery_term;
650 $details{payment_terms} = $cv->payment->description if $cv->payment;
651 $details{pricegroup} = $cv->pricegroup->pricegroup if $is_customer && $cv->pricegroup;
653 foreach my $entry (@{ $cv->shipto }) {
654 push @{ $details{SHIPTO} }, { map { $_ => $entry->$_ } @{$entry->meta->columns} };
656 foreach my $entry (@{ $cv->contacts }) {
657 push @{ $details{CONTACTS} }, { map { $_ => $entry->$_ } @{$entry->meta->columns} };
660 $_[0]->render('common/show_vc_details', { layout => 0 },
661 is_customer => $is_customer,
666 # called if a unit in an existing item row is changed
667 sub action_unit_changed {
670 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
671 my $item = $self->order->items_sorted->[$idx];
673 my $old_unit_obj = SL::DB::Unit->new(name => $::form->{old_unit})->load;
674 $item->sellprice($item->unit_obj->convert_to($item->sellprice, $old_unit_obj));
679 ->run('kivi.Order.update_sellprice', $::form->{item_id}, $item->sellprice_as_number);
680 $self->js_redisplay_line_values;
681 $self->js_redisplay_amounts_and_taxes;
685 # add an item row for a new item entered in the input row
686 sub action_add_item {
689 my $form_attr = $::form->{add_item};
691 return unless $form_attr->{parts_id};
693 my $item = new_item($self->order, $form_attr);
695 $self->order->add_items($item);
699 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
700 my $row_as_html = $self->p->render('order/tabs/_row',
704 ALL_PRICE_FACTORS => $self->all_price_factors
708 ->append('#row_table_id', $row_as_html);
710 if ( $item->part->is_assortment ) {
711 $form_attr->{qty_as_number} = 1 unless $form_attr->{qty_as_number};
712 foreach my $assortment_item ( @{$item->part->assortment_items} ) {
713 my $attr = { parts_id => $assortment_item->parts_id,
714 qty => $assortment_item->qty * $::form->parse_amount(\%::myconfig, $form_attr->{qty_as_number}), # TODO $form_attr->{unit}
715 unit => $assortment_item->unit,
716 description => $assortment_item->part->description,
718 my $item = new_item($self->order, $attr);
720 # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount
721 $item->discount(1) unless $assortment_item->charge;
723 $self->order->add_items( $item );
725 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
726 my $row_as_html = $self->p->render('order/tabs/_row',
730 ALL_PRICE_FACTORS => $self->all_price_factors
733 ->append('#row_table_id', $row_as_html);
738 ->val('.add_item_input', '')
739 ->run('kivi.Order.init_row_handlers')
740 ->run('kivi.Order.row_table_scroll_down')
741 ->run('kivi.Order.renumber_positions')
742 ->focus('#add_item_parts_id_name');
744 $self->js_redisplay_amounts_and_taxes;
748 # open the dialog for entering multiple items at once
749 sub action_show_multi_items_dialog {
750 $_[0]->render('order/tabs/_multi_items_dialog', { layout => 0 },
751 all_partsgroups => SL::DB::Manager::PartsGroup->get_all);
754 # update the filter results in the multi item dialog
755 sub action_multi_items_update_result {
758 $::form->{multi_items}->{filter}->{obsolete} = 0;
760 my $count = $_[0]->multi_items_models->count;
763 my $text = SL::Presenter::EscapedText->new(text => $::locale->text('No results.'));
764 $_[0]->render($text, { layout => 0 });
765 } elsif ($count > $max_count) {
766 my $text = SL::Presenter::EscapedText->new(text => $::locale->text('Too many results (#1 from #2).', $count, $max_count));
767 $_[0]->render($text, { layout => 0 });
769 my $multi_items = $_[0]->multi_items_models->get;
770 $_[0]->render('order/tabs/_multi_items_result', { layout => 0 },
771 multi_items => $multi_items);
775 # add item rows for multiple items at once
776 sub action_add_multi_items {
779 my @form_attr = grep { $_->{qty_as_number} } @{ $::form->{add_multi_items} };
780 return $self->js->render() unless scalar @form_attr;
783 foreach my $attr (@form_attr) {
784 my $item = new_item($self->order, $attr);
786 if ( $item->part->is_assortment ) {
787 foreach my $assortment_item ( @{$item->part->assortment_items} ) {
788 my $attr = { parts_id => $assortment_item->parts_id,
789 qty => $assortment_item->qty * $item->qty, # TODO $form_attr->{unit}
790 unit => $assortment_item->unit,
791 description => $assortment_item->part->description,
793 my $item = new_item($self->order, $attr);
795 # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount
796 $item->discount(1) unless $assortment_item->charge;
801 $self->order->add_items(@items);
805 foreach my $item (@items) {
806 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
807 my $row_as_html = $self->p->render('order/tabs/_row',
811 ALL_PRICE_FACTORS => $self->all_price_factors
814 $self->js->append('#row_table_id', $row_as_html);
818 ->run('kivi.Order.close_multi_items_dialog')
819 ->run('kivi.Order.init_row_handlers')
820 ->run('kivi.Order.row_table_scroll_down')
821 ->run('kivi.Order.renumber_positions')
822 ->focus('#add_item_parts_id_name');
824 $self->js_redisplay_amounts_and_taxes;
828 # recalculate all linetotals, amounts and taxes and redisplay them
829 sub action_recalc_amounts_and_taxes {
834 $self->js_redisplay_line_values;
835 $self->js_redisplay_amounts_and_taxes;
839 # redisplay item rows if they are sorted by an attribute
840 sub action_reorder_items {
844 partnumber => sub { $_[0]->part->partnumber },
845 description => sub { $_[0]->description },
846 qty => sub { $_[0]->qty },
847 sellprice => sub { $_[0]->sellprice },
848 discount => sub { $_[0]->discount },
851 my $method = $sort_keys{$::form->{order_by}};
852 my @to_sort = map { { old_pos => $_->position, order_by => $method->($_) } } @{ $self->order->items_sorted };
853 if ($::form->{sort_dir}) {
854 @to_sort = sort { $a->{order_by} cmp $b->{order_by} } @to_sort;
856 @to_sort = sort { $b->{order_by} cmp $a->{order_by} } @to_sort;
859 ->run('kivi.Order.redisplay_items', \@to_sort)
863 # show the popup to choose a price/discount source
864 sub action_price_popup {
867 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
868 my $item = $self->order->items_sorted->[$idx];
870 $self->render_price_dialog($item);
873 # get the longdescription for an item if the dialog to enter/change the
874 # longdescription was opened and the longdescription is empty
876 # If this item is new, get the longdescription from Part.
877 # Otherwise get it from OrderItem.
878 sub action_get_item_longdescription {
881 if ($::form->{item_id}) {
882 $longdescription = SL::DB::OrderItem->new(id => $::form->{item_id})->load->longdescription;
883 } elsif ($::form->{parts_id}) {
884 $longdescription = SL::DB::Part->new(id => $::form->{parts_id})->load->notes;
886 $_[0]->render(\ $longdescription, { type => 'text' });
889 # load the second row for one or more items
891 # This action gets the html code for all items second rows by rendering a template for
892 # the second row and sets the html code via client js.
893 sub action_load_second_rows {
896 $self->recalc() if $self->order->is_sales; # for margin calculation
898 foreach my $item_id (@{ $::form->{item_ids} }) {
899 my $idx = first_index { $_ eq $item_id } @{ $::form->{orderitem_ids} };
900 my $item = $self->order->items_sorted->[$idx];
902 $self->js_load_second_row($item, $item_id, 0);
905 $self->js->run('kivi.Order.init_row_handlers') if $self->order->is_sales; # for lastcosts change-callback
910 sub js_load_second_row {
911 my ($self, $item, $item_id, $do_parse) = @_;
914 # Parse values from form (they are formated while rendering (template)).
915 # Workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
916 # This parsing is not necessary at all, if we assure that the second row/cvars are only loaded once.
917 foreach my $var (@{ $item->cvars_by_config }) {
918 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
920 $item->parse_custom_variable_values;
923 my $row_as_html = $self->p->render('order/tabs/_second_row', ITEM => $item, TYPE => $self->type);
926 ->html('.row_entry:has(#item_' . $item_id . ') [name = "second_row"]', $row_as_html)
927 ->data('.row_entry:has(#item_' . $item_id . ') [name = "second_row"]', 'loaded', 1);
930 sub js_redisplay_line_values {
933 my $is_sales = $self->order->is_sales;
935 # sales orders with margins
940 $::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0),
941 $::form->format_amount(\%::myconfig, $_->{marge_total}, 2, 0),
942 $::form->format_amount(\%::myconfig, $_->{marge_percent}, 2, 0),
943 ]} @{ $self->order->items_sorted };
947 $::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0),
948 ]} @{ $self->order->items_sorted };
952 ->run('kivi.Order.redisplay_line_values', $is_sales, \@data);
955 sub js_redisplay_amounts_and_taxes {
958 if (scalar @{ $self->{taxes} }) {
959 $self->js->show('#taxincluded_row_id');
961 $self->js->hide('#taxincluded_row_id');
964 if ($self->order->taxincluded) {
965 $self->js->hide('#subtotal_row_id');
967 $self->js->show('#subtotal_row_id');
970 if ($self->order->is_sales) {
971 my $is_neg = $self->order->marge_total < 0;
973 ->html('#marge_total_id', $::form->format_amount(\%::myconfig, $self->order->marge_total, 2))
974 ->html('#marge_percent_id', $::form->format_amount(\%::myconfig, $self->order->marge_percent, 2))
975 ->action_if( $is_neg, 'addClass', '#marge_total_id', 'plus0')
976 ->action_if( $is_neg, 'addClass', '#marge_percent_id', 'plus0')
977 ->action_if( $is_neg, 'addClass', '#marge_percent_sign_id', 'plus0')
978 ->action_if(!$is_neg, 'removeClass', '#marge_total_id', 'plus0')
979 ->action_if(!$is_neg, 'removeClass', '#marge_percent_id', 'plus0')
980 ->action_if(!$is_neg, 'removeClass', '#marge_percent_sign_id', 'plus0');
984 ->html('#netamount_id', $::form->format_amount(\%::myconfig, $self->order->netamount, -2))
985 ->html('#amount_id', $::form->format_amount(\%::myconfig, $self->order->amount, -2))
987 ->insertBefore($self->build_tax_rows, '#amount_row_id');
994 sub init_valid_types {
995 [ sales_order_type(), purchase_order_type(), sales_quotation_type(), request_quotation_type() ];
1001 if (none { $::form->{type} eq $_ } @{$self->valid_types}) {
1002 die "Not a valid type for order";
1005 $self->type($::form->{type});
1011 my $cv = (any { $self->type eq $_ } (sales_order_type(), sales_quotation_type())) ? 'customer'
1012 : (any { $self->type eq $_ } (purchase_order_type(), request_quotation_type())) ? 'vendor'
1013 : die "Not a valid type for order";
1026 # model used to filter/display the parts in the multi-items dialog
1027 sub init_multi_items_models {
1028 SL::Controller::Helper::GetModels->new(
1029 controller => $_[0],
1031 with_objects => [ qw(unit_obj) ],
1032 disable_plugin => 'paginated',
1033 source => $::form->{multi_items},
1039 partnumber => t8('Partnumber'),
1040 description => t8('Description')}
1044 sub init_all_price_factors {
1045 SL::DB::Manager::PriceFactor->get_all;
1051 my $right_for = { map { $_ => $_.'_edit' } @{$self->valid_types} };
1053 my $right = $right_for->{ $self->type };
1054 $right ||= 'DOES_NOT_EXIST';
1056 $::auth->assert($right);
1059 # build the selection box for contacts
1061 # Needed, if customer/vendor changed.
1062 sub build_contact_select {
1065 select_tag('order.cp_id', [ $self->order->{$self->cv}->contacts ],
1066 value_key => 'cp_id',
1067 title_key => 'full_name_dep',
1068 default => $self->order->cp_id,
1070 style => 'width: 300px',
1074 # build the selection box for shiptos
1076 # Needed, if customer/vendor changed.
1077 sub build_shipto_select {
1080 select_tag('order.shipto_id', [ $self->order->{$self->cv}->shipto ],
1081 value_key => 'shipto_id',
1082 title_key => 'displayable_id',
1083 default => $self->order->shipto_id,
1085 style => 'width: 300px',
1089 # render the info line for business
1091 # Needed, if customer/vendor changed.
1092 sub build_business_info_row
1094 $_[0]->p->render('order/tabs/_business_info_row', SELF => $_[0]);
1097 # build the rows for displaying taxes
1099 # Called if amounts where recalculated and redisplayed.
1100 sub build_tax_rows {
1104 foreach my $tax (sort { $a->{tax}->rate cmp $b->{tax}->rate } @{ $self->{taxes} }) {
1105 $rows_as_html .= $self->p->render('order/tabs/_tax_row', TAX => $tax, TAXINCLUDED => $self->order->taxincluded);
1107 return $rows_as_html;
1111 sub render_price_dialog {
1112 my ($self, $record_item) = @_;
1114 my $price_source = SL::PriceSource->new(record_item => $record_item, record => $self->order);
1118 'kivi.io.price_chooser_dialog',
1119 t8('Available Prices'),
1120 $self->render('order/tabs/_price_sources_dialog', { output => 0 }, price_source => $price_source)
1125 # $self->js->text('#dialog_flash_error_content', join ' ', @errors);
1126 # $self->js->show('#dialog_flash_error');
1135 return if !$::form->{id};
1137 $self->order(SL::DB::Order->new(id => $::form->{id})->load);
1140 # load or create a new order object
1142 # And assign changes from the form to this object.
1143 # If the order is loaded from db, check if items are deleted in the form,
1144 # remove them form the object and collect them for removing from db on saving.
1145 # Then create/update items from form (via make_item) and add them.
1149 # add_items adds items to an order with no items for saving, but they cannot
1150 # be retrieved via items until the order is saved. Adding empty items to new
1151 # order here solves this problem.
1153 $order = SL::DB::Manager::Order->find_by(id => $::form->{id}) if $::form->{id};
1154 $order ||= SL::DB::Order->new(orderitems => [],
1155 quotation => (any { $self->type eq $_ } (sales_quotation_type(), request_quotation_type())));
1157 my $cv_id_method = $self->cv . '_id';
1158 if (!$::form->{id} && $::form->{$cv_id_method}) {
1159 $order->$cv_id_method($::form->{$cv_id_method});
1160 setup_order_from_cv($order);
1163 my $form_orderitems = delete $::form->{order}->{orderitems};
1164 my $form_periodic_invoices_config = delete $::form->{order}->{periodic_invoices_config};
1166 $order->assign_attributes(%{$::form->{order}});
1168 my $periodic_invoices_config = make_periodic_invoices_config_from_yaml($form_periodic_invoices_config);
1169 $order->periodic_invoices_config($periodic_invoices_config) if $periodic_invoices_config;
1171 # remove deleted items
1172 $self->item_ids_to_delete([]);
1173 foreach my $idx (reverse 0..$#{$order->orderitems}) {
1174 my $item = $order->orderitems->[$idx];
1175 if (none { $item->id == $_->{id} } @{$form_orderitems}) {
1176 splice @{$order->orderitems}, $idx, 1;
1177 push @{$self->item_ids_to_delete}, $item->id;
1183 foreach my $form_attr (@{$form_orderitems}) {
1184 my $item = make_item($order, $form_attr);
1185 $item->position($pos);
1189 $order->add_items(grep {!$_->id} @items);
1194 # create or update items from form
1196 # Make item objects from form values. For items already existing read from db.
1197 # Create a new item else. And assign attributes.
1199 my ($record, $attr) = @_;
1202 $item = first { $_->id == $attr->{id} } @{$record->items} if $attr->{id};
1204 my $is_new = !$item;
1206 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
1207 # they cannot be retrieved via custom_variables until the order/orderitem is
1208 # saved. Adding empty custom_variables to new orderitem here solves this problem.
1209 $item ||= SL::DB::OrderItem->new(custom_variables => []);
1211 $item->assign_attributes(%$attr);
1212 $item->longdescription($item->part->notes) if $is_new && !defined $attr->{longdescription};
1213 $item->project_id($record->globalproject_id) if $is_new && !defined $attr->{project_id};
1214 $item->lastcost($record->is_sales ? $item->part->lastcost : 0) if $is_new && !defined $attr->{lastcost_as_number};
1221 # This is used to add one item
1223 my ($record, $attr) = @_;
1225 my $item = SL::DB::OrderItem->new;
1227 # Remove attributes where the user left or set the inputs empty.
1228 # So these attributes will be undefined and we can distinguish them
1229 # from zero later on.
1230 for (qw(qty_as_number sellprice_as_number discount_as_percent)) {
1231 delete $attr->{$_} if $attr->{$_} eq '';
1234 $item->assign_attributes(%$attr);
1236 my $part = SL::DB::Part->new(id => $attr->{parts_id})->load;
1237 my $price_source = SL::PriceSource->new(record_item => $item, record => $record);
1239 $item->unit($part->unit) if !$item->unit;
1242 if ( $part->is_assortment ) {
1243 # add assortment items with price 0, as the components carry the price
1244 $price_src = $price_source->price_from_source("");
1245 $price_src->price(0);
1246 } elsif (defined $item->sellprice) {
1247 $price_src = $price_source->price_from_source("");
1248 $price_src->price($item->sellprice);
1250 $price_src = $price_source->best_price
1251 ? $price_source->best_price
1252 : $price_source->price_from_source("");
1253 $price_src->price(0) if !$price_source->best_price;
1257 if (defined $item->discount) {
1258 $discount_src = $price_source->discount_from_source("");
1259 $discount_src->discount($item->discount);
1261 $discount_src = $price_source->best_discount
1262 ? $price_source->best_discount
1263 : $price_source->discount_from_source("");
1264 $discount_src->discount(0) if !$price_source->best_discount;
1268 $new_attr{part} = $part;
1269 $new_attr{description} = $part->description if ! $item->description;
1270 $new_attr{qty} = 1.0 if ! $item->qty;
1271 $new_attr{price_factor_id} = $part->price_factor_id if ! $item->price_factor_id;
1272 $new_attr{sellprice} = $price_src->price;
1273 $new_attr{discount} = $discount_src->discount;
1274 $new_attr{active_price_source} = $price_src;
1275 $new_attr{active_discount_source} = $discount_src;
1276 $new_attr{longdescription} = $part->notes if ! defined $attr->{longdescription};
1277 $new_attr{project_id} = $record->globalproject_id;
1278 $new_attr{lastcost} = $record->is_sales ? $part->lastcost : 0;
1280 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
1281 # they cannot be retrieved via custom_variables until the order/orderitem is
1282 # saved. Adding empty custom_variables to new orderitem here solves this problem.
1283 $new_attr{custom_variables} = [];
1285 $item->assign_attributes(%new_attr);
1290 sub setup_order_from_cv {
1293 $order->$_($order->customervendor->$_) for (qw(taxzone_id payment_id delivery_term_id));
1295 $order->intnotes($order->customervendor->notes);
1297 if ($order->is_sales) {
1298 $order->salesman_id($order->customer->salesman_id || SL::DB::Manager::Employee->current->id);
1299 $order->taxincluded(defined($order->customer->taxincluded_checked)
1300 ? $order->customer->taxincluded_checked
1301 : $::myconfig{taxincluded_checked});
1306 # recalculate prices and taxes
1308 # Using the PriceTaxCalculator. Store linetotals in the item objects.
1312 # bb: todo: currency later
1313 $self->order->currency_id($::instance_conf->get_currency_id());
1315 my %pat = $self->order->calculate_prices_and_taxes();
1316 $self->{taxes} = [];
1317 foreach my $tax_chart_id (keys %{ $pat{taxes} }) {
1318 my $tax = SL::DB::Manager::Tax->find_by(chart_id => $tax_chart_id);
1320 my @amount_keys = grep { $pat{amounts}->{$_}->{tax_id} == $tax->id } keys %{ $pat{amounts} };
1321 push(@{ $self->{taxes} }, { amount => $pat{taxes}->{$tax_chart_id},
1322 netamount => $pat{amounts}->{$amount_keys[0]}->{amount},
1326 pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items}, @{$pat{items}};
1329 # get data for saving, printing, ..., that is not changed in the form
1331 # Only cvars for now.
1332 sub get_unalterable_data {
1335 foreach my $item (@{ $self->order->items }) {
1336 # autovivify all cvars that are not in the form (cvars_by_config can do it).
1337 # workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
1338 foreach my $var (@{ $item->cvars_by_config }) {
1339 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
1341 $item->parse_custom_variable_values;
1347 # And remove related files in the spool directory
1352 my $db = $self->order->db;
1354 $db->with_transaction(
1356 my @spoolfiles = grep { $_ } map { $_->spoolfile } @{ SL::DB::Manager::Status->get_all(where => [ trans_id => $self->order->id ]) };
1357 $self->order->delete;
1358 my $spool = $::lx_office_conf{paths}->{spool};
1359 unlink map { "$spool/$_" } @spoolfiles if $spool;
1362 }) || push(@{$errors}, $db->error);
1369 # And delete items that are deleted in the form.
1374 my $db = $self->order->db;
1376 $db->with_transaction(sub {
1377 SL::DB::OrderItem->new(id => $_)->delete for @{$self->item_ids_to_delete};
1378 $self->order->save(cascade => 1);
1381 if ($::form->{converted_from_oe_id}) {
1382 SL::DB::Order->new(id => $::form->{converted_from_oe_id})->load->link_to_record($self->order);
1384 if (scalar @{ $::form->{converted_from_orderitems_ids} || [] }) {
1386 foreach (@{ $self->order->items_sorted }) {
1387 my $from_id = $::form->{converted_from_orderitems_ids}->[$idx];
1389 SL::DB::RecordLink->new(from_table => 'orderitems',
1390 from_id => $from_id,
1391 to_table => 'orderitems',
1399 }) || push(@{$errors}, $db->error);
1404 sub workflow_sales_or_purchase_order {
1407 my $destination_type = $::form->{type} eq sales_quotation_type() ? sales_order_type()
1408 : $::form->{type} eq request_quotation_type() ? purchase_order_type()
1409 : $::form->{type} eq purchase_order_type() ? sales_order_type()
1410 : $::form->{type} eq sales_order_type() ? purchase_order_type()
1413 $self->order(SL::DB::Order->new_from($self->order, destination_type => $destination_type));
1414 $self->{converted_from_oe_id} = delete $::form->{id};
1416 # set item ids to new fake id, to identify them as new items
1417 foreach my $item (@{$self->order->items_sorted}) {
1418 $item->{new_fake_id} = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
1422 $::form->{type} = $destination_type;
1423 $self->type($self->init_type);
1424 $self->cv ($self->init_cv);
1428 $self->get_unalterable_data();
1429 $self->pre_render();
1431 # trigger rendering values for second row/longdescription as hidden,
1432 # because they are loaded only on demand. So we need to keep the values
1434 $_->{render_second_row} = 1 for @{ $self->order->items_sorted };
1435 $_->{render_longdescription} = 1 for @{ $self->order->items_sorted };
1439 title => $self->get_title_for('edit'),
1440 %{$self->{template_args}}
1448 $self->{all_taxzones} = SL::DB::Manager::TaxZone->get_all_sorted();
1449 $self->{all_departments} = SL::DB::Manager::Department->get_all_sorted();
1450 $self->{all_employees} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->employee_id,
1453 $self->{all_salesmen} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->salesman_id,
1456 $self->{all_payment_terms} = SL::DB::Manager::PaymentTerm->get_all_sorted(where => [ or => [ id => $self->order->payment_id,
1458 $self->{all_delivery_terms} = SL::DB::Manager::DeliveryTerm->get_all_sorted();
1459 $self->{current_employee_id} = SL::DB::Manager::Employee->current->id;
1460 $self->{periodic_invoices_status} = $self->get_periodic_invoices_status($self->order->periodic_invoices_config);
1461 $self->{order_probabilities} = [ map { { title => ($_ * 10) . '%', id => $_ * 10 } } (0..10) ];
1463 my $print_form = Form->new('');
1464 $print_form->{type} = $self->type;
1465 $print_form->{printers} = SL::DB::Manager::Printer->get_all_sorted;
1466 $print_form->{languages} = SL::DB::Manager::Language->get_all_sorted;
1467 $self->{print_options} = SL::Helper::PrintOptions->get_print_options(
1468 form => $print_form,
1469 options => {dialog_name_prefix => 'print_options.',
1473 no_opendocument => 0,
1477 foreach my $item (@{$self->order->orderitems}) {
1478 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
1479 $item->active_price_source( $price_source->price_from_source( $item->active_price_source ));
1480 $item->active_discount_source($price_source->discount_from_source($item->active_discount_source));
1483 if (any { $self->type eq $_ } (sales_order_type(), purchase_order_type())) {
1484 # calculate shipped qtys here to prevent calling calculate for every item via the items method
1485 SL::Helper::ShippedQty->new->calculate($self->order)->write_to_objects;
1488 if ($self->order->number && $::instance_conf->get_webdav) {
1489 my $webdav = SL::Webdav->new(
1490 type => $self->type,
1491 number => $self->order->number,
1493 my @all_objects = $webdav->get_all_objects;
1494 @{ $self->{template_args}->{WEBDAV} } = map { { name => $_->filename,
1496 link => File::Spec->catfile($_->full_filedescriptor),
1500 $::request->{layout}->use_javascript("${_}.js") for qw(kivi.SalesPurchase kivi.Order kivi.File ckeditor/ckeditor ckeditor/adapters/jquery edit_periodic_invoices_config calculate_qty);
1501 $self->setup_edit_action_bar;
1504 sub setup_edit_action_bar {
1505 my ($self, %params) = @_;
1507 my $deletion_allowed = (any { $self->type eq $_ } (sales_quotation_type(), request_quotation_type()))
1508 || (($self->type eq sales_order_type()) && $::instance_conf->get_sales_order_show_delete)
1509 || (($self->type eq purchase_order_type()) && $::instance_conf->get_purchase_order_show_delete);
1511 for my $bar ($::request->layout->get('actionbar')) {
1516 call => [ 'kivi.Order.save', 'save', $::instance_conf->get_order_warn_duplicate_parts,
1517 $::instance_conf->get_order_warn_no_deliverydate,
1519 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1523 call => [ 'kivi.Order.save', 'save_as_new', $::instance_conf->get_order_warn_duplicate_parts ],
1524 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1525 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1527 ], # end of combobox "Save"
1535 submit => [ '#order_form', { action => "Order/sales_order" } ],
1536 only_if => (any { $self->type eq $_ } (sales_quotation_type(), purchase_order_type())),
1537 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1540 t8('Purchase Order'),
1541 submit => [ '#order_form', { action => "Order/purchase_order" } ],
1542 only_if => (any { $self->type eq $_ } (sales_order_type(), request_quotation_type())),
1543 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1546 t8('Save and Delivery Order'),
1547 call => [ 'kivi.Order.save', 'save_and_delivery_order', $::instance_conf->get_order_warn_duplicate_parts,
1548 $::instance_conf->get_order_warn_no_deliverydate,
1550 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1551 only_if => (any { $self->type eq $_ } (sales_order_type(), purchase_order_type()))
1554 t8('Save and Invoice'),
1555 call => [ 'kivi.Order.save', 'save_and_invoice', $::instance_conf->get_order_warn_duplicate_parts ],
1556 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1558 ], # end of combobox "Workflow"
1566 call => [ 'kivi.Order.show_print_options' ],
1570 call => [ 'kivi.Order.email' ],
1573 t8('Download attachments of all parts'),
1574 call => [ 'kivi.File.downloadOrderitemsFiles', $::form->{type}, $::form->{id} ],
1575 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1576 only_if => $::instance_conf->get_doc_storage,
1578 ], # end of combobox "Export"
1582 call => [ 'kivi.Order.delete_order' ],
1583 confirm => $::locale->text('Do you really want to delete this object?'),
1584 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1585 only_if => $deletion_allowed,
1592 my ($order, $pdf_ref, $params) = @_;
1596 my $print_form = Form->new('');
1597 $print_form->{type} = $order->type;
1598 $print_form->{formname} = $params->{formname} || $order->type;
1599 $print_form->{format} = $params->{format} || 'pdf';
1600 $print_form->{media} = $params->{media} || 'file';
1601 $print_form->{groupitems} = $params->{groupitems};
1602 $print_form->{media} = 'file' if $print_form->{media} eq 'screen';
1604 $order->language($params->{language});
1605 $order->flatten_to_form($print_form, format_amounts => 1);
1609 if ($print_form->{format} =~ /(opendocument|oasis)/i) {
1610 $template_ext = 'odt';
1611 $template_type = 'OpenDocument';
1614 # search for the template
1615 my ($template_file, @template_files) = SL::Helper::CreatePDF->find_template(
1616 name => $print_form->{formname},
1617 extension => $template_ext,
1618 email => $print_form->{media} eq 'email',
1619 language => $params->{language},
1620 printer_id => $print_form->{printer_id}, # todo
1623 if (!defined $template_file) {
1624 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);
1627 return @errors if scalar @errors;
1629 $print_form->throw_on_error(sub {
1631 $print_form->prepare_for_printing;
1633 $$pdf_ref = SL::Helper::CreatePDF->create_pdf(
1634 format => $print_form->{format},
1635 template_type => $template_type,
1636 template => $template_file,
1637 variables => $print_form,
1638 variable_content_types => {
1639 longdescription => 'html',
1640 partnotes => 'html',
1645 } || push @errors, ref($EVAL_ERROR) eq 'SL::X::FormError' ? $EVAL_ERROR->getMessage : $EVAL_ERROR;
1651 sub get_files_for_email_dialog {
1654 my %files = map { ($_ => []) } qw(versions files vc_files part_files);
1656 return %files if !$::instance_conf->get_doc_storage;
1658 if ($self->order->id) {
1659 $files{versions} = [ SL::File->get_all_versions(object_id => $self->order->id, object_type => $self->order->type, file_type => 'document') ];
1660 $files{files} = [ SL::File->get_all( object_id => $self->order->id, object_type => $self->order->type, file_type => 'attachment') ];
1661 $files{vc_files} = [ SL::File->get_all( object_id => $self->order->{$self->cv}->id, object_type => $self->cv, file_type => 'attachment') ];
1665 uniq_by { $_->{id} }
1667 +{ id => $_->part->id,
1668 partnumber => $_->part->partnumber }
1669 } @{$self->order->items_sorted};
1671 foreach my $part (@parts) {
1672 my @pfiles = SL::File->get_all(object_id => $part->{id}, object_type => 'part');
1673 push @{ $files{part_files} }, map { +{ %{ $_ }, partnumber => $part->{partnumber} } } @pfiles;
1676 foreach my $key (keys %files) {
1677 $files{$key} = [ sort_by { lc $_->{db_file}->{file_name} } @{ $files{$key} } ];
1683 sub make_periodic_invoices_config_from_yaml {
1684 my ($yaml_config) = @_;
1686 return if !$yaml_config;
1687 my $attr = YAML::Load($yaml_config);
1688 return if 'HASH' ne ref $attr;
1689 return SL::DB::PeriodicInvoicesConfig->new(%$attr);
1693 sub get_periodic_invoices_status {
1694 my ($self, $config) = @_;
1696 return if $self->type ne sales_order_type();
1697 return t8('not configured') if !$config;
1699 my $active = ('HASH' eq ref $config) ? $config->{active}
1700 : ('SL::DB::PeriodicInvoicesConfig' eq ref $config) ? $config->active
1701 : die "Cannot get status of periodic invoices config";
1703 return $active ? t8('active') : t8('inactive');
1707 my ($self, $action) = @_;
1709 return '' if none { lc($action)} qw(add edit);
1712 # $::locale->text("Add Sales Order");
1713 # $::locale->text("Add Purchase Order");
1714 # $::locale->text("Add Quotation");
1715 # $::locale->text("Add Request for Quotation");
1716 # $::locale->text("Edit Sales Order");
1717 # $::locale->text("Edit Purchase Order");
1718 # $::locale->text("Edit Quotation");
1719 # $::locale->text("Edit Request for Quotation");
1721 $action = ucfirst(lc($action));
1722 return $self->type eq sales_order_type() ? $::locale->text("$action Sales Order")
1723 : $self->type eq purchase_order_type() ? $::locale->text("$action Purchase Order")
1724 : $self->type eq sales_quotation_type() ? $::locale->text("$action Quotation")
1725 : $self->type eq request_quotation_type() ? $::locale->text("$action Request for Quotation")
1729 sub sales_order_type {
1733 sub purchase_order_type {
1737 sub sales_quotation_type {
1741 sub request_quotation_type {
1742 'request_quotation';
1746 return $_[0]->type eq sales_order_type() ? 'ordnumber'
1747 : $_[0]->type eq purchase_order_type() ? 'ordnumber'
1748 : $_[0]->type eq sales_quotation_type() ? 'quonumber'
1749 : $_[0]->type eq request_quotation_type() ? 'quonumber'
1761 SL::Controller::Order - controller for orders
1765 This is a new form to enter orders, completely rewritten with the use
1766 of controller and java script techniques.
1768 The aim is to provide the user a better expirience and a faster flow
1769 of work. Also the code should be more readable, more reliable and
1778 One input row, so that input happens every time at the same place.
1782 Use of pickers where possible.
1786 Possibility to enter more than one item at once.
1790 Save order only on "save" (and "save and delivery order"-workflow). No
1791 hidden save on "print" or "email".
1795 Item list in a scrollable area, so that the workflow buttons stay at
1800 Reordering item rows with drag and drop is possible. Sorting item rows is
1801 possible (by partnumber, description, qty, sellprice and discount for now).
1805 No C<update> is necessary. All entries and calculations are managed
1806 with ajax-calls and the page does only reload on C<save>.
1810 User can see changes immediately, because of the use of java script
1821 =item * C<SL/Controller/Order.pm>
1825 =item * C<template/webpages/order/form.html>
1829 =item * C<template/webpages/order/tabs/basic_data.html>
1831 Main tab for basic_data.
1833 This is the only tab here for now. "linked records" and "webdav" tabs are
1834 reused from generic code.
1838 =item * C<template/webpages/order/tabs/_business_info_row.html>
1840 For displaying information on business type
1842 =item * C<template/webpages/order/tabs/_item_input.html>
1844 The input line for items
1846 =item * C<template/webpages/order/tabs/_row.html>
1848 One row for already entered items
1850 =item * C<template/webpages/order/tabs/_tax_row.html>
1852 Displaying tax information
1854 =item * C<template/webpages/order/tabs/_multi_items_dialog.html>
1856 Dialog for entering more than one item at once
1858 =item * C<template/webpages/order/tabs/_multi_items_result.html>
1860 Results for the filter in the multi items dialog
1862 =item * C<template/webpages/order/tabs/_price_sources_dialog.html>
1864 Dialog for selecting price and discount sources
1868 =item * C<js/kivi.Order.js>
1870 java script functions
1882 =item * credit limit
1884 =item * more workflows (quotation, rfq)
1886 =item * price sources: little symbols showing better price / better discount
1888 =item * select units in input row?
1890 =item * custom shipto address
1892 =item * check for direct delivery (workflow sales order -> purchase order)
1894 =item * language / part translations
1896 =item * access rights
1898 =item * display weights
1904 =item * optional client/user behaviour
1906 (transactions has to be set - department has to be set -
1907 force project if enabled in client config - transport cost reminder)
1911 =head1 KNOWN BUGS AND CAVEATS
1917 Customer discount is not displayed as a valid discount in price source popup
1918 (this might be a bug in price sources)
1920 (I cannot reproduce this (Bernd))
1924 No indication that <shift>-up/down expands/collapses second row.
1928 Inline creation of parts is not currently supported
1932 Table header is not sticky in the scrolling area.
1936 Sorting does not include C<position>, neither does reordering.
1938 This behavior was implemented intentionally. But we can discuss, which behavior
1939 should be implemented.
1943 C<show_multi_items_dialog> does not use the currently inserted string for
1948 The language selected in print or email dialog is not saved when the order is saved.
1952 =head1 To discuss / Nice to have
1958 How to expand/collapse second row. Now it can be done clicking the icon or
1963 Possibility to change longdescription in input row?
1967 Possibility to select PriceSources in input row?
1971 This controller uses a (changed) copy of the template for the PriceSource
1972 dialog. Maybe there could be used one code source.
1976 Rounding-differences between this controller (PriceTaxCalculator) and the old
1977 form. This is not only a problem here, but also in all parts using the PTC.
1978 There exists a ticket and a patch. This patch should be testet.
1982 An indicator, if the actual inputs are saved (like in an
1983 editor or on text processing application).
1987 A warning when leaving the page without saveing unchanged inputs.
1994 Bernd Bleßmann E<lt>bernd@kivitendo-premium.deE<gt>