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);
20 use SL::DB::RecordLink;
22 use SL::Helper::CreatePDF qw(:all);
23 use SL::Helper::PrintOptions;
25 use SL::Controller::Helper::GetModels;
27 use List::Util qw(first);
28 use List::UtilsBy qw(sort_by uniq_by);
29 use List::MoreUtils qw(any none pairwise first_index);
30 use English qw(-no_match_vars);
34 use Rose::Object::MakeMethods::Generic
36 scalar => [ qw(item_ids_to_delete) ],
37 'scalar --get_set_init' => [ qw(order valid_types type cv p multi_items_models all_price_factors) ],
42 __PACKAGE__->run_before('_check_auth');
44 __PACKAGE__->run_before('_recalc',
45 only => [ qw(save save_as_new save_and_delivery_order save_and_invoice print create_pdf send_email) ]);
47 __PACKAGE__->run_before('_get_unalterable_data',
48 only => [ qw(save save_as_new save_and_delivery_order save_and_invoice print create_pdf send_email) ]);
58 $self->order->transdate(DateTime->now_local());
59 my $extra_days = $self->type eq _sales_quotation_type() ? $::instance_conf->get_reqdate_interval : 1;
60 $self->order->reqdate(DateTime->today_local->next_workday(extra_days => $extra_days)) if !$self->order->reqdate;
65 title => $self->_get_title_for('add'),
66 %{$self->{template_args}}
70 # edit an existing order
79 title => $self->_get_title_for('edit'),
80 %{$self->{template_args}}
88 my $errors = $self->_delete();
90 if (scalar @{ $errors }) {
91 $self->js->flash('error', $_) foreach @{ $errors };
92 return $self->js->render();
95 my $text = $self->type eq _sales_order_type() ? $::locale->text('The order has been deleted')
96 : $self->type eq _purchase_order_type() ? $::locale->text('The order has been deleted')
97 : $self->type eq _sales_quotation_type() ? $::locale->text('The quotation has been deleted')
98 : $self->type eq _request_quotation_type() ? $::locale->text('The rfq has been deleted')
100 flash_later('info', $text);
102 my @redirect_params = (
107 $self->redirect_to(@redirect_params);
114 my $errors = $self->_save();
116 if (scalar @{ $errors }) {
117 $self->js->flash('error', $_) foreach @{ $errors };
118 return $self->js->render();
121 my $text = $self->type eq _sales_order_type() ? $::locale->text('The order has been saved')
122 : $self->type eq _purchase_order_type() ? $::locale->text('The order has been saved')
123 : $self->type eq _sales_quotation_type() ? $::locale->text('The quotation has been saved')
124 : $self->type eq _request_quotation_type() ? $::locale->text('The rfq has been saved')
126 flash_later('info', $text);
128 my @redirect_params = (
131 id => $self->order->id,
134 $self->redirect_to(@redirect_params);
137 # save the order as new document an open it for edit
138 sub action_save_as_new {
141 my $order = $self->order;
144 $self->js->flash('error', t8('This object has not been saved yet.'));
145 return $self->js->render();
148 # load order from db to check if values changed
149 my $saved_order = SL::DB::Order->new(id => $order->id)->load;
152 # Lets assign a new number if the user hasn't changed the previous one.
153 # If it has been changed manually then use it as-is.
154 $new_attrs{number} = (trim($order->number) eq $saved_order->number)
156 : trim($order->number);
158 # Clear transdate unless changed
159 $new_attrs{transdate} = ($order->transdate == $saved_order->transdate)
160 ? DateTime->today_local
163 # Set new reqdate unless changed
164 if ($order->reqdate == $saved_order->reqdate) {
165 my $extra_days = $self->type eq _sales_quotation_type() ? $::instance_conf->get_reqdate_interval : 1;
166 $new_attrs{reqdate} = DateTime->today_local->next_workday(extra_days => $extra_days);
168 $new_attrs{reqdate} = $order->reqdate;
172 $new_attrs{employee} = SL::DB::Manager::Employee->current;
174 # Create new record from current one
175 $self->order(SL::DB::Order->new_from($order, destination_type => $order->type, attributes => \%new_attrs));
177 # no linked records on save as new
178 delete $::form->{$_} for qw(converted_from_oe_id converted_from_orderitems_ids);
181 $self->action_save();
186 # This is called if "print" is pressed in the print dialog.
187 # If PDF creation was requested and succeeded, the pdf is stored in a session
188 # file and the filename is stored as session value with an unique key. A
189 # javascript function with this key is then called. This function calls the
190 # download action below (action_download_pdf), which offers the file for
195 my $format = $::form->{print_options}->{format};
196 my $media = $::form->{print_options}->{media};
197 my $formname = $::form->{print_options}->{formname};
198 my $copies = $::form->{print_options}->{copies};
199 my $groupitems = $::form->{print_options}->{groupitems};
202 if (none { $format eq $_ } qw(pdf)) {
203 return $self->js->flash('error', t8('Format \'#1\' is not supported yet/anymore.', $format))->render;
206 # only screen or printer by now
207 if (none { $media eq $_ } qw(screen printer)) {
208 return $self->js->flash('error', t8('Media \'#1\' is not supported yet/anymore.', $media))->render;
212 $language = SL::DB::Language->new(id => $::form->{print_options}->{language_id})->load if $::form->{print_options}->{language_id};
214 # create a form for generate_attachment_filename
215 my $form = Form->new;
216 $form->{$self->_nr_key()} = $self->order->number;
217 $form->{type} = $self->type;
218 $form->{format} = $format;
219 $form->{formname} = $formname;
220 $form->{language} = '_' . $language->template_code if $language;
221 my $pdf_filename = $form->generate_attachment_filename();
224 my @errors = _create_pdf($self->order, \$pdf, { format => $format,
225 formname => $formname,
226 language => $language,
227 groupitems => $groupitems });
228 if (scalar @errors) {
229 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render;
232 if ($media eq 'screen') {
234 my $sfile = SL::SessionFile::Random->new(mode => "w");
235 $sfile->fh->print($pdf);
238 my $key = join('_', Time::HiRes::gettimeofday(), int rand 1000000000000);
239 $::auth->set_session_value("Order::create_pdf-${key}" => $sfile->file_name);
242 ->run('kivi.Order.download_pdf', $pdf_filename, $key)
243 ->flash('info', t8('The PDF has been created'));
245 } elsif ($media eq 'printer') {
247 my $printer_id = $::form->{print_options}->{printer_id};
248 SL::DB::Printer->new(id => $printer_id)->load->print_document(
253 $self->js->flash('info', t8('The PDF has been printed'));
256 # copy file to webdav folder
257 if ($self->order->number && $::instance_conf->get_webdav_documents) {
258 my $webdav = SL::Webdav->new(
260 number => $self->order->number,
262 my $webdav_file = SL::Webdav::File->new(
264 filename => $pdf_filename,
267 $webdav_file->store(data => \$pdf);
270 $self->js->flash('error', t8('Storing PDF to webdav folder failed: #1', $@));
273 if ($self->order->number && $::instance_conf->get_doc_storage) {
275 SL::File->save(object_id => $self->order->id,
276 object_type => $self->type,
277 mime_type => 'application/pdf',
279 file_type => 'document',
280 file_name => $pdf_filename,
281 file_contents => $pdf);
284 $self->js->flash('error', t8('Storing PDF in storage backend failed: #1', $@));
290 # offer pdf for download
292 # It needs to get the key for the session value to get the pdf file.
293 sub action_download_pdf {
296 my $key = $::form->{key};
297 my $tmp_filename = $::auth->get_session_value("Order::create_pdf-${key}");
298 return $self->send_file(
300 type => 'application/pdf',
301 name => $::form->{pdf_filename},
305 # open the email dialog
306 sub action_show_email_dialog {
309 my $cv_method = $self->cv;
311 if (!$self->order->$cv_method) {
312 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'))
317 $email_form->{to} = $self->order->contact->cp_email if $self->order->contact;
318 $email_form->{to} ||= $self->order->$cv_method->email;
319 $email_form->{cc} = $self->order->$cv_method->cc;
320 $email_form->{bcc} = join ', ', grep $_, $self->order->$cv_method->bcc, SL::DB::Default->get->global_bcc;
321 # Todo: get addresses from shipto, if any
323 my $form = Form->new;
324 $form->{$self->_nr_key()} = $self->order->number;
325 $form->{formname} = $self->type;
326 $form->{type} = $self->type;
327 $form->{language} = 'de';
328 $form->{format} = 'pdf';
330 $email_form->{subject} = $form->generate_email_subject();
331 $email_form->{attachment_filename} = $form->generate_attachment_filename();
332 $email_form->{message} = $form->generate_email_body();
333 $email_form->{js_send_function} = 'kivi.Order.send_email()';
335 my %files = $self->_get_files_for_email_dialog();
336 my $dialog_html = $self->render('common/_send_email_dialog', { output => 0 },
337 email_form => $email_form,
338 show_bcc => $::auth->assert('email_bcc', 'may fail'),
340 is_customer => $self->cv eq 'customer',
344 ->run('kivi.Order.show_email_dialog', $dialog_html)
351 # Todo: handling error messages: flash is not displayed in dialog, but in the main form
352 sub action_send_email {
355 my $email_form = delete $::form->{email_form};
356 my %field_names = (to => 'email');
358 $::form->{ $field_names{$_} // $_ } = $email_form->{$_} for keys %{ $email_form };
360 # for Form::cleanup which may be called in Form::send_email
361 $::form->{cwd} = getcwd();
362 $::form->{tmpdir} = $::lx_office_conf{paths}->{userspath};
364 $::form->{$_} = $::form->{print_options}->{$_} for keys %{ $::form->{print_options} };
365 $::form->{media} = 'email';
367 if (($::form->{attachment_policy} // '') !~ m{^(?:old_file|no_file)$}) {
369 $language = SL::DB::Language->new(id => $::form->{print_options}->{language_id})->load if $::form->{print_options}->{language_id};
372 my @errors = _create_pdf($self->order, \$pdf, {media => $::form->{media},
373 format => $::form->{print_options}->{format},
374 formname => $::form->{print_options}->{formname},
375 language => $language,
376 groupitems => $::form->{print_options}->{groupitems}});
377 if (scalar @errors) {
378 return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
381 my $sfile = SL::SessionFile::Random->new(mode => "w");
382 $sfile->fh->print($pdf);
385 $::form->{tmpfile} = $sfile->file_name;
386 $::form->{tmpdir} = $sfile->get_path; # for Form::cleanup which may be called in Form::send_email
389 $::form->send_email(\%::myconfig, 'pdf');
392 my $intnotes = $self->order->intnotes;
393 $intnotes .= "\n\n" if $self->order->intnotes;
394 $intnotes .= t8('[email]') . "\n";
395 $intnotes .= t8('Date') . ": " . $::locale->format_date_object(DateTime->now_local, precision => 'seconds') . "\n";
396 $intnotes .= t8('To (email)') . ": " . $::form->{email} . "\n";
397 $intnotes .= t8('Cc') . ": " . $::form->{cc} . "\n" if $::form->{cc};
398 $intnotes .= t8('Bcc') . ": " . $::form->{bcc} . "\n" if $::form->{bcc};
399 $intnotes .= t8('Subject') . ": " . $::form->{subject} . "\n\n";
400 $intnotes .= t8('Message') . ": " . $::form->{message};
403 ->val('#order_intnotes', $intnotes)
404 ->run('kivi.Order.close_email_dialog')
405 ->flash('info', t8('The email has been sent.'))
409 # open the periodic invoices config dialog
411 # If there are values in the form (i.e. dialog was opened before),
412 # then use this values. Create new ones, else.
413 sub action_show_periodic_invoices_config_dialog {
416 my $config = _make_periodic_invoices_config_from_yaml(delete $::form->{config});
417 $config ||= SL::DB::Manager::PeriodicInvoicesConfig->find_by(oe_id => $::form->{id}) if $::form->{id};
418 $config ||= SL::DB::PeriodicInvoicesConfig->new(periodicity => 'm',
419 order_value_periodicity => 'p', # = same as periodicity
420 start_date_as_date => $::form->{transdate} || $::form->current_date,
421 extend_automatically_by => 12,
423 email_subject => GenericTranslations->get(
424 language_id => $::form->{language_id},
425 translation_type =>"preset_text_periodic_invoices_email_subject"),
426 email_body => GenericTranslations->get(
427 language_id => $::form->{language_id},
428 translation_type =>"preset_text_periodic_invoices_email_body"),
430 $config->periodicity('m') if none { $_ eq $config->periodicity } @SL::DB::PeriodicInvoicesConfig::PERIODICITIES;
431 $config->order_value_periodicity('p') if none { $_ eq $config->order_value_periodicity } ('p', @SL::DB::PeriodicInvoicesConfig::ORDER_VALUE_PERIODICITIES);
433 $::form->get_lists(printers => "ALL_PRINTERS",
434 charts => { key => 'ALL_CHARTS',
435 transdate => 'current_date' });
437 $::form->{AR} = [ grep { $_->{link} =~ m/(?:^|:)AR(?::|$)/ } @{ $::form->{ALL_CHARTS} } ];
439 if ($::form->{customer_id}) {
440 $::form->{ALL_CONTACTS} = SL::DB::Manager::Contact->get_all_sorted(where => [ cp_cv_id => $::form->{customer_id} ]);
443 $self->render('oe/edit_periodic_invoices_config', { layout => 0 },
445 popup_js_close_function => 'kivi.Order.close_periodic_invoices_config_dialog()',
446 popup_js_assign_function => 'kivi.Order.assign_periodic_invoices_config()',
451 # assign the values of the periodic invoices config dialog
452 # as yaml in the hidden tag and set the status.
453 sub action_assign_periodic_invoices_config {
456 $::form->isblank('start_date_as_date', $::locale->text('The start date is missing.'));
458 my $config = { active => $::form->{active} ? 1 : 0,
459 terminated => $::form->{terminated} ? 1 : 0,
460 direct_debit => $::form->{direct_debit} ? 1 : 0,
461 periodicity => (any { $_ eq $::form->{periodicity} } @SL::DB::PeriodicInvoicesConfig::PERIODICITIES) ? $::form->{periodicity} : 'm',
462 order_value_periodicity => (any { $_ eq $::form->{order_value_periodicity} } ('p', @SL::DB::PeriodicInvoicesConfig::ORDER_VALUE_PERIODICITIES)) ? $::form->{order_value_periodicity} : 'p',
463 start_date_as_date => $::form->{start_date_as_date},
464 end_date_as_date => $::form->{end_date_as_date},
465 first_billing_date_as_date => $::form->{first_billing_date_as_date},
466 print => $::form->{print} ? 1 : 0,
467 printer_id => $::form->{print} ? $::form->{printer_id} * 1 : undef,
468 copies => $::form->{copies} * 1 ? $::form->{copies} : 1,
469 extend_automatically_by => $::form->{extend_automatically_by} * 1 || undef,
470 ar_chart_id => $::form->{ar_chart_id} * 1,
471 send_email => $::form->{send_email} ? 1 : 0,
472 email_recipient_contact_id => $::form->{email_recipient_contact_id} * 1 || undef,
473 email_recipient_address => $::form->{email_recipient_address},
474 email_sender => $::form->{email_sender},
475 email_subject => $::form->{email_subject},
476 email_body => $::form->{email_body},
479 my $periodic_invoices_config = YAML::Dump($config);
481 my $status = $self->_get_periodic_invoices_status($config);
484 ->remove('#order_periodic_invoices_config')
485 ->insertAfter(hidden_tag('order.periodic_invoices_config', $periodic_invoices_config), '#periodic_invoices_status')
486 ->run('kivi.Order.close_periodic_invoices_config_dialog')
487 ->html('#periodic_invoices_status', $status)
488 ->flash('info', t8('The periodic invoices config has been assigned.'))
492 sub action_get_has_active_periodic_invoices {
495 my $config = _make_periodic_invoices_config_from_yaml(delete $::form->{config});
496 $config ||= SL::DB::Manager::PeriodicInvoicesConfig->find_by(oe_id => $::form->{id}) if $::form->{id};
498 my $has_active_periodic_invoices =
499 $self->type eq _sales_order_type()
502 && (!$config->end_date || ($config->end_date > DateTime->today_local))
503 && $config->get_previous_billed_period_start_date;
505 $_[0]->render(\ !!$has_active_periodic_invoices, { type => 'text' });
508 # save the order and redirect to the frontend subroutine for a new
510 sub action_save_and_delivery_order {
513 my $errors = $self->_save();
515 if (scalar @{ $errors }) {
516 $self->js->flash('error', $_) foreach @{ $errors };
517 return $self->js->render();
520 my $text = $self->type eq _sales_order_type() ? $::locale->text('The order has been saved')
521 : $self->type eq _purchase_order_type() ? $::locale->text('The order has been saved')
522 : $self->type eq _sales_quotation_type() ? $::locale->text('The quotation has been saved')
523 : $self->type eq _request_quotation_type() ? $::locale->text('The rfq has been saved')
525 flash_later('info', $text);
527 my @redirect_params = (
528 controller => 'oe.pl',
529 action => 'oe_delivery_order_from_order',
530 id => $self->order->id,
533 $self->redirect_to(@redirect_params);
536 # save the order and redirect to the frontend subroutine for a new
538 sub action_save_and_invoice {
541 my $errors = $self->_save();
543 if (scalar @{ $errors }) {
544 $self->js->flash('error', $_) foreach @{ $errors };
545 return $self->js->render();
548 my $text = $self->type eq _sales_order_type() ? $::locale->text('The order has been saved')
549 : $self->type eq _purchase_order_type() ? $::locale->text('The order has been saved')
550 : $self->type eq _sales_quotation_type() ? $::locale->text('The quotation has been saved')
551 : $self->type eq _request_quotation_type() ? $::locale->text('The rfq has been saved')
553 flash_later('info', $text);
555 my @redirect_params = (
556 controller => 'oe.pl',
557 action => 'oe_invoice_from_order',
558 id => $self->order->id,
561 $self->redirect_to(@redirect_params);
564 # workflow from sales quotation to sales order
565 sub action_sales_order {
566 $_[0]->_workflow_sales_or_purchase_order();
569 # workflow from rfq to purchase order
570 sub action_purchase_order {
571 $_[0]->_workflow_sales_or_purchase_order();
574 # set form elements in respect to a changed customer or vendor
576 # This action is called on an change of the customer/vendor picker.
577 sub action_customer_vendor_changed {
580 _setup_order_from_cv($self->order);
583 my $cv_method = $self->cv;
585 if ($self->order->$cv_method->contacts && scalar @{ $self->order->$cv_method->contacts } > 0) {
586 $self->js->show('#cp_row');
588 $self->js->hide('#cp_row');
591 if ($self->order->$cv_method->shipto && scalar @{ $self->order->$cv_method->shipto } > 0) {
592 $self->js->show('#shipto_row');
594 $self->js->hide('#shipto_row');
597 $self->js->val( '#order_salesman_id', $self->order->salesman_id) if $self->order->is_sales;
600 ->replaceWith('#order_cp_id', $self->build_contact_select)
601 ->replaceWith('#order_shipto_id', $self->build_shipto_select)
602 ->replaceWith('#business_info_row', $self->build_business_info_row)
603 ->val( '#order_taxzone_id', $self->order->taxzone_id)
604 ->val( '#order_taxincluded', $self->order->taxincluded)
605 ->val( '#order_payment_id', $self->order->payment_id)
606 ->val( '#order_delivery_term_id', $self->order->delivery_term_id)
607 ->val( '#order_intnotes', $self->order->intnotes)
608 ->focus( '#order_' . $self->cv . '_id');
610 $self->_js_redisplay_amounts_and_taxes;
614 # open the dialog for customer/vendor details
615 sub action_show_customer_vendor_details_dialog {
618 my $is_customer = 'customer' eq $::form->{vc};
621 $cv = SL::DB::Customer->new(id => $::form->{vc_id})->load;
623 $cv = SL::DB::Vendor->new(id => $::form->{vc_id})->load;
626 my %details = map { $_ => $cv->$_ } @{$cv->meta->columns};
627 $details{discount_as_percent} = $cv->discount_as_percent;
628 $details{creditlimt} = $cv->creditlimit_as_number;
629 $details{business} = $cv->business->description if $cv->business;
630 $details{language} = $cv->language_obj->description if $cv->language_obj;
631 $details{delivery_terms} = $cv->delivery_term->description if $cv->delivery_term;
632 $details{payment_terms} = $cv->payment->description if $cv->payment;
633 $details{pricegroup} = $cv->pricegroup->pricegroup if $is_customer && $cv->pricegroup;
635 foreach my $entry (@{ $cv->shipto }) {
636 push @{ $details{SHIPTO} }, { map { $_ => $entry->$_ } @{$entry->meta->columns} };
638 foreach my $entry (@{ $cv->contacts }) {
639 push @{ $details{CONTACTS} }, { map { $_ => $entry->$_ } @{$entry->meta->columns} };
642 $_[0]->render('common/show_vc_details', { layout => 0 },
643 is_customer => $is_customer,
648 # called if a unit in an existing item row is changed
649 sub action_unit_changed {
652 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
653 my $item = $self->order->items_sorted->[$idx];
655 my $old_unit_obj = SL::DB::Unit->new(name => $::form->{old_unit})->load;
656 $item->sellprice($item->unit_obj->convert_to($item->sellprice, $old_unit_obj));
661 ->run('kivi.Order.update_sellprice', $::form->{item_id}, $item->sellprice_as_number);
662 $self->_js_redisplay_line_values;
663 $self->_js_redisplay_amounts_and_taxes;
667 # add an item row for a new item entered in the input row
668 sub action_add_item {
671 my $form_attr = $::form->{add_item};
673 return unless $form_attr->{parts_id};
675 my $item = _new_item($self->order, $form_attr);
677 $self->order->add_items($item);
681 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
682 my $row_as_html = $self->p->render('order/tabs/_row',
686 ALL_PRICE_FACTORS => $self->all_price_factors
690 ->append('#row_table_id', $row_as_html);
692 if ( $item->part->is_assortment ) {
693 $form_attr->{qty_as_number} = 1 unless $form_attr->{qty_as_number};
694 foreach my $assortment_item ( @{$item->part->assortment_items} ) {
695 my $attr = { parts_id => $assortment_item->parts_id,
696 qty => $assortment_item->qty * $::form->parse_amount(\%::myconfig, $form_attr->{qty_as_number}), # TODO $form_attr->{unit}
697 unit => $assortment_item->unit,
698 description => $assortment_item->part->description,
700 my $item = _new_item($self->order, $attr);
702 # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount
703 $item->discount(1) unless $assortment_item->charge;
705 $self->order->add_items( $item );
707 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
708 my $row_as_html = $self->p->render('order/tabs/_row',
712 ALL_PRICE_FACTORS => $self->all_price_factors
715 ->append('#row_table_id', $row_as_html);
720 ->val('.add_item_input', '')
721 ->run('kivi.Order.init_row_handlers')
722 ->run('kivi.Order.row_table_scroll_down')
723 ->run('kivi.Order.renumber_positions')
724 ->focus('#add_item_parts_id_name');
726 $self->_js_redisplay_amounts_and_taxes;
730 # open the dialog for entering multiple items at once
731 sub action_show_multi_items_dialog {
732 require SL::DB::PartsGroup;
733 $_[0]->render('order/tabs/_multi_items_dialog', { layout => 0 },
734 all_partsgroups => SL::DB::Manager::PartsGroup->get_all);
737 # update the filter results in the multi item dialog
738 sub action_multi_items_update_result {
741 $::form->{multi_items}->{filter}->{obsolete} = 0;
743 my $count = $_[0]->multi_items_models->count;
746 my $text = SL::Presenter::EscapedText->new(text => $::locale->text('No results.'));
747 $_[0]->render($text, { layout => 0 });
748 } elsif ($count > $max_count) {
749 my $text = SL::Presenter::EscapedText->new(text => $::locale->text('Too many results (#1 from #2).', $count, $max_count));
750 $_[0]->render($text, { layout => 0 });
752 my $multi_items = $_[0]->multi_items_models->get;
753 $_[0]->render('order/tabs/_multi_items_result', { layout => 0 },
754 multi_items => $multi_items);
758 # add item rows for multiple items at once
759 sub action_add_multi_items {
762 my @form_attr = grep { $_->{qty_as_number} } @{ $::form->{add_multi_items} };
763 return $self->js->render() unless scalar @form_attr;
766 foreach my $attr (@form_attr) {
767 my $item = _new_item($self->order, $attr);
769 if ( $item->part->is_assortment ) {
770 foreach my $assortment_item ( @{$item->part->assortment_items} ) {
771 my $attr = { parts_id => $assortment_item->parts_id,
772 qty => $assortment_item->qty * $item->qty, # TODO $form_attr->{unit}
773 unit => $assortment_item->unit,
774 description => $assortment_item->part->description,
776 my $item = _new_item($self->order, $attr);
778 # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount
779 $item->discount(1) unless $assortment_item->charge;
784 $self->order->add_items(@items);
788 foreach my $item (@items) {
789 my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
790 my $row_as_html = $self->p->render('order/tabs/_row',
794 ALL_PRICE_FACTORS => $self->all_price_factors
797 $self->js->append('#row_table_id', $row_as_html);
801 ->run('kivi.Order.close_multi_items_dialog')
802 ->run('kivi.Order.init_row_handlers')
803 ->run('kivi.Order.row_table_scroll_down')
804 ->run('kivi.Order.renumber_positions')
805 ->focus('#add_item_parts_id_name');
807 $self->_js_redisplay_amounts_and_taxes;
811 # recalculate all linetotals, amounts and taxes and redisplay them
812 sub action_recalc_amounts_and_taxes {
817 $self->_js_redisplay_line_values;
818 $self->_js_redisplay_amounts_and_taxes;
822 # redisplay item rows if they are sorted by an attribute
823 sub action_reorder_items {
827 partnumber => sub { $_[0]->part->partnumber },
828 description => sub { $_[0]->description },
829 qty => sub { $_[0]->qty },
830 sellprice => sub { $_[0]->sellprice },
831 discount => sub { $_[0]->discount },
834 my $method = $sort_keys{$::form->{order_by}};
835 my @to_sort = map { { old_pos => $_->position, order_by => $method->($_) } } @{ $self->order->items_sorted };
836 if ($::form->{sort_dir}) {
837 @to_sort = sort { $a->{order_by} cmp $b->{order_by} } @to_sort;
839 @to_sort = sort { $b->{order_by} cmp $a->{order_by} } @to_sort;
842 ->run('kivi.Order.redisplay_items', \@to_sort)
846 # show the popup to choose a price/discount source
847 sub action_price_popup {
850 my $idx = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
851 my $item = $self->order->items_sorted->[$idx];
853 $self->render_price_dialog($item);
856 # get the longdescription for an item if the dialog to enter/change the
857 # longdescription was opened and the longdescription is empty
859 # If this item is new, get the longdescription from Part.
860 # Otherwise get it from OrderItem.
861 sub action_get_item_longdescription {
864 if ($::form->{item_id}) {
865 $longdescription = SL::DB::OrderItem->new(id => $::form->{item_id})->load->longdescription;
866 } elsif ($::form->{parts_id}) {
867 $longdescription = SL::DB::Part->new(id => $::form->{parts_id})->load->notes;
869 $_[0]->render(\ $longdescription, { type => 'text' });
872 # load the second row for one or more items
874 # This action gets the html code for all items second rows by rendering a template for
875 # the second row and sets the html code via client js.
876 sub action_load_second_rows {
879 $self->_recalc() if $self->order->is_sales; # for margin calculation
881 foreach my $item_id (@{ $::form->{item_ids} }) {
882 my $idx = first_index { $_ eq $item_id } @{ $::form->{orderitem_ids} };
883 my $item = $self->order->items_sorted->[$idx];
885 $self->_js_load_second_row($item, $item_id, 0);
888 $self->js->run('kivi.Order.init_row_handlers') if $self->order->is_sales; # for lastcosts change-callback
893 sub _js_load_second_row {
894 my ($self, $item, $item_id, $do_parse) = @_;
897 # Parse values from form (they are formated while rendering (template)).
898 # Workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
899 # This parsing is not necessary at all, if we assure that the second row/cvars are only loaded once.
900 foreach my $var (@{ $item->cvars_by_config }) {
901 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
903 $item->parse_custom_variable_values;
906 my $row_as_html = $self->p->render('order/tabs/_second_row', ITEM => $item, TYPE => $self->type);
909 ->html('.row_entry:has(#item_' . $item_id . ') [name = "second_row"]', $row_as_html)
910 ->data('.row_entry:has(#item_' . $item_id . ') [name = "second_row"]', 'loaded', 1);
913 sub _js_redisplay_line_values {
916 my $is_sales = $self->order->is_sales;
918 # sales orders with margins
923 $::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0),
924 $::form->format_amount(\%::myconfig, $_->{marge_total}, 2, 0),
925 $::form->format_amount(\%::myconfig, $_->{marge_percent}, 2, 0),
926 ]} @{ $self->order->items_sorted };
930 $::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0),
931 ]} @{ $self->order->items_sorted };
935 ->run('kivi.Order.redisplay_line_values', $is_sales, \@data);
938 sub _js_redisplay_amounts_and_taxes {
941 if (scalar @{ $self->{taxes} }) {
942 $self->js->show('#taxincluded_row_id');
944 $self->js->hide('#taxincluded_row_id');
947 if ($self->order->taxincluded) {
948 $self->js->hide('#subtotal_row_id');
950 $self->js->show('#subtotal_row_id');
954 ->html('#netamount_id', $::form->format_amount(\%::myconfig, $self->order->netamount, -2))
955 ->html('#amount_id', $::form->format_amount(\%::myconfig, $self->order->amount, -2))
957 ->insertBefore($self->build_tax_rows, '#amount_row_id');
964 sub init_valid_types {
965 [ _sales_order_type(), _purchase_order_type(), _sales_quotation_type(), _request_quotation_type() ];
971 if (none { $::form->{type} eq $_ } @{$self->valid_types}) {
972 die "Not a valid type for order";
975 $self->type($::form->{type});
981 my $cv = (any { $self->type eq $_ } (_sales_order_type(), _sales_quotation_type())) ? 'customer'
982 : (any { $self->type eq $_ } (_purchase_order_type(), _request_quotation_type())) ? 'vendor'
983 : die "Not a valid type for order";
996 # model used to filter/display the parts in the multi-items dialog
997 sub init_multi_items_models {
998 SL::Controller::Helper::GetModels->new(
1001 with_objects => [ qw(unit_obj) ],
1002 disable_plugin => 'paginated',
1003 source => $::form->{multi_items},
1009 partnumber => t8('Partnumber'),
1010 description => t8('Description')}
1014 sub init_all_price_factors {
1015 SL::DB::Manager::PriceFactor->get_all;
1021 my $right_for = { map { $_ => $_.'_edit' } @{$self->valid_types} };
1023 my $right = $right_for->{ $self->type };
1024 $right ||= 'DOES_NOT_EXIST';
1026 $::auth->assert($right);
1029 # build the selection box for contacts
1031 # Needed, if customer/vendor changed.
1032 sub build_contact_select {
1035 select_tag('order.cp_id', [ $self->order->{$self->cv}->contacts ],
1036 value_key => 'cp_id',
1037 title_key => 'full_name_dep',
1038 default => $self->order->cp_id,
1040 style => 'width: 300px',
1044 # build the selection box for shiptos
1046 # Needed, if customer/vendor changed.
1047 sub build_shipto_select {
1050 select_tag('order.shipto_id', [ $self->order->{$self->cv}->shipto ],
1051 value_key => 'shipto_id',
1052 title_key => 'displayable_id',
1053 default => $self->order->shipto_id,
1055 style => 'width: 300px',
1059 # render the info line for business
1061 # Needed, if customer/vendor changed.
1062 sub build_business_info_row
1064 $_[0]->p->render('order/tabs/_business_info_row', SELF => $_[0]);
1067 # build the rows for displaying taxes
1069 # Called if amounts where recalculated and redisplayed.
1070 sub build_tax_rows {
1074 foreach my $tax (sort { $a->{tax}->rate cmp $b->{tax}->rate } @{ $self->{taxes} }) {
1075 $rows_as_html .= $self->p->render('order/tabs/_tax_row', TAX => $tax, TAXINCLUDED => $self->order->taxincluded);
1077 return $rows_as_html;
1081 sub render_price_dialog {
1082 my ($self, $record_item) = @_;
1084 my $price_source = SL::PriceSource->new(record_item => $record_item, record => $self->order);
1088 'kivi.io.price_chooser_dialog',
1089 t8('Available Prices'),
1090 $self->render('order/tabs/_price_sources_dialog', { output => 0 }, price_source => $price_source)
1095 # $self->js->text('#dialog_flash_error_content', join ' ', @errors);
1096 # $self->js->show('#dialog_flash_error');
1105 return if !$::form->{id};
1107 $self->order(SL::DB::Manager::Order->find_by(id => $::form->{id}));
1110 # load or create a new order object
1112 # And assign changes from the form to this object.
1113 # If the order is loaded from db, check if items are deleted in the form,
1114 # remove them form the object and collect them for removing from db on saving.
1115 # Then create/update items from form (via _make_item) and add them.
1119 # add_items adds items to an order with no items for saving, but they cannot
1120 # be retrieved via items until the order is saved. Adding empty items to new
1121 # order here solves this problem.
1123 $order = SL::DB::Manager::Order->find_by(id => $::form->{id}) if $::form->{id};
1124 $order ||= SL::DB::Order->new(orderitems => [],
1125 quotation => (any { $self->type eq $_ } (_sales_quotation_type(), _request_quotation_type())));
1127 my $cv_id_method = $self->cv . '_id';
1128 if (!$::form->{id} && $::form->{$cv_id_method}) {
1129 $order->$cv_id_method($::form->{$cv_id_method});
1130 _setup_order_from_cv($order);
1133 my $form_orderitems = delete $::form->{order}->{orderitems};
1134 my $form_periodic_invoices_config = delete $::form->{order}->{periodic_invoices_config};
1136 $order->assign_attributes(%{$::form->{order}});
1138 my $periodic_invoices_config = _make_periodic_invoices_config_from_yaml($form_periodic_invoices_config);
1139 $order->periodic_invoices_config($periodic_invoices_config) if $periodic_invoices_config;
1141 # remove deleted items
1142 $self->item_ids_to_delete([]);
1143 foreach my $idx (reverse 0..$#{$order->orderitems}) {
1144 my $item = $order->orderitems->[$idx];
1145 if (none { $item->id == $_->{id} } @{$form_orderitems}) {
1146 splice @{$order->orderitems}, $idx, 1;
1147 push @{$self->item_ids_to_delete}, $item->id;
1153 foreach my $form_attr (@{$form_orderitems}) {
1154 my $item = _make_item($order, $form_attr);
1155 $item->position($pos);
1159 $order->add_items(grep {!$_->id} @items);
1164 # create or update items from form
1166 # Make item objects from form values. For items already existing read from db.
1167 # Create a new item else. And assign attributes.
1169 my ($record, $attr) = @_;
1172 $item = first { $_->id == $attr->{id} } @{$record->items} if $attr->{id};
1174 my $is_new = !$item;
1176 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
1177 # they cannot be retrieved via custom_variables until the order/orderitem is
1178 # saved. Adding empty custom_variables to new orderitem here solves this problem.
1179 $item ||= SL::DB::OrderItem->new(custom_variables => []);
1181 $item->assign_attributes(%$attr);
1182 $item->longdescription($item->part->notes) if $is_new && !defined $attr->{longdescription};
1183 $item->project_id($record->globalproject_id) if $is_new && !defined $attr->{project_id};
1184 $item->lastcost($record->is_sales ? $item->part->lastcost : 0) if $is_new && !defined $attr->{lastcost_as_number};
1191 # This is used to add one item
1193 my ($record, $attr) = @_;
1195 my $item = SL::DB::OrderItem->new;
1196 $item->assign_attributes(%$attr);
1198 my $part = SL::DB::Part->new(id => $attr->{parts_id})->load;
1199 my $price_source = SL::PriceSource->new(record_item => $item, record => $record);
1201 $item->unit($part->unit) if !$item->unit;
1204 if ( $part->is_assortment ) {
1205 # add assortment items with price 0, as the components carry the price
1206 $price_src = $price_source->price_from_source("");
1207 $price_src->price(0);
1208 } elsif ($item->sellprice) {
1209 $price_src = $price_source->price_from_source("");
1210 $price_src->price($item->sellprice);
1212 $price_src = $price_source->best_price
1213 ? $price_source->best_price
1214 : $price_source->price_from_source("");
1215 $price_src->price(0) if !$price_source->best_price;
1219 if ($item->discount) {
1220 $discount_src = $price_source->discount_from_source("");
1221 $discount_src->discount($item->discount);
1223 $discount_src = $price_source->best_discount
1224 ? $price_source->best_discount
1225 : $price_source->discount_from_source("");
1226 $discount_src->discount(0) if !$price_source->best_discount;
1230 $new_attr{part} = $part;
1231 $new_attr{description} = $part->description if ! $item->description;
1232 $new_attr{qty} = 1.0 if ! $item->qty;
1233 $new_attr{price_factor_id} = $part->price_factor_id if ! $item->price_factor_id;
1234 $new_attr{sellprice} = $price_src->price;
1235 $new_attr{discount} = $discount_src->discount;
1236 $new_attr{active_price_source} = $price_src;
1237 $new_attr{active_discount_source} = $discount_src;
1238 $new_attr{longdescription} = $part->notes if ! defined $attr->{longdescription};
1239 $new_attr{project_id} = $record->globalproject_id;
1240 $new_attr{lastcost} = $record->is_sales ? $part->lastcost : 0;
1242 # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
1243 # they cannot be retrieved via custom_variables until the order/orderitem is
1244 # saved. Adding empty custom_variables to new orderitem here solves this problem.
1245 $new_attr{custom_variables} = [];
1247 $item->assign_attributes(%new_attr);
1252 sub _setup_order_from_cv {
1255 $order->$_($order->customervendor->$_) for (qw(taxzone_id payment_id delivery_term_id));
1257 $order->intnotes($order->customervendor->notes);
1259 if ($order->is_sales) {
1260 $order->salesman_id($order->customer->salesman_id);
1261 $order->taxincluded(defined($order->customer->taxincluded_checked)
1262 ? $order->customer->taxincluded_checked
1263 : $::myconfig{taxincluded_checked});
1268 # recalculate prices and taxes
1270 # Using the PriceTaxCalculator. Store linetotals in the item objects.
1274 # bb: todo: currency later
1275 $self->order->currency_id($::instance_conf->get_currency_id());
1277 my %pat = $self->order->calculate_prices_and_taxes();
1278 $self->{taxes} = [];
1279 foreach my $tax_chart_id (keys %{ $pat{taxes} }) {
1280 my $tax = SL::DB::Manager::Tax->find_by(chart_id => $tax_chart_id);
1282 my @amount_keys = grep { $pat{amounts}->{$_}->{tax_id} == $tax->id } keys %{ $pat{amounts} };
1283 push(@{ $self->{taxes} }, { amount => $pat{taxes}->{$tax_chart_id},
1284 netamount => $pat{amounts}->{$amount_keys[0]}->{amount},
1288 pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items}, @{$pat{items}};
1291 # get data for saving, printing, ..., that is not changed in the form
1293 # Only cvars for now.
1294 sub _get_unalterable_data {
1297 foreach my $item (@{ $self->order->items }) {
1298 # autovivify all cvars that are not in the form (cvars_by_config can do it).
1299 # workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
1300 foreach my $var (@{ $item->cvars_by_config }) {
1301 $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
1303 $item->parse_custom_variable_values;
1309 # And remove related files in the spool directory
1314 my $db = $self->order->db;
1316 $db->with_transaction(
1318 my @spoolfiles = grep { $_ } map { $_->spoolfile } @{ SL::DB::Manager::Status->get_all(where => [ trans_id => $self->order->id ]) };
1319 $self->order->delete;
1320 my $spool = $::lx_office_conf{paths}->{spool};
1321 unlink map { "$spool/$_" } @spoolfiles if $spool;
1324 }) || push(@{$errors}, $db->error);
1331 # And delete items that are deleted in the form.
1336 my $db = $self->order->db;
1338 $db->with_transaction(sub {
1339 SL::DB::OrderItem->new(id => $_)->delete for @{$self->item_ids_to_delete};
1340 $self->order->save(cascade => 1);
1343 if ($::form->{converted_from_oe_id}) {
1344 SL::DB::Order->new(id => $::form->{converted_from_oe_id})->load->link_to_record($self->order);
1346 if (scalar @{ $::form->{converted_from_orderitems_ids} || [] }) {
1348 foreach (@{ $self->order->items_sorted }) {
1349 my $from_id = $::form->{converted_from_orderitems_ids}->[$idx];
1351 SL::DB::RecordLink->new(from_table => 'orderitems',
1352 from_id => $from_id,
1353 to_table => 'orderitems',
1361 }) || push(@{$errors}, $db->error);
1366 sub _workflow_sales_or_purchase_order {
1369 my $destination_type = $::form->{type} eq _sales_quotation_type() ? _sales_order_type()
1370 : $::form->{type} eq _request_quotation_type() ? _purchase_order_type()
1371 : $::form->{type} eq _purchase_order_type() ? _sales_order_type()
1372 : $::form->{type} eq _sales_order_type() ? _purchase_order_type()
1375 $self->order(SL::DB::Order->new_from($self->order, destination_type => $destination_type));
1376 $self->{converted_from_oe_id} = delete $::form->{id};
1378 # set item ids to new fake id, to identify them as new items
1379 foreach my $item (@{$self->order->items_sorted}) {
1380 $item->{new_fake_id} = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
1384 $::form->{type} = $destination_type;
1385 $self->type($self->init_type);
1386 $self->cv ($self->init_cv);
1390 $self->_get_unalterable_data();
1391 $self->_pre_render();
1393 # trigger rendering values for second row/longdescription as hidden,
1394 # because they are loaded only on demand. So we need to keep the values
1396 $_->{render_second_row} = 1 for @{ $self->order->items_sorted };
1397 $_->{render_longdescription} = 1 for @{ $self->order->items_sorted };
1401 title => $self->_get_title_for('edit'),
1402 %{$self->{template_args}}
1410 $self->{all_taxzones} = SL::DB::Manager::TaxZone->get_all_sorted();
1411 $self->{all_departments} = SL::DB::Manager::Department->get_all_sorted();
1412 $self->{all_employees} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->employee_id,
1415 $self->{all_salesmen} = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->salesman_id,
1418 $self->{all_projects} = SL::DB::Manager::Project->get_all(where => [ or => [ id => $self->order->globalproject_id,
1420 sort_by => 'projectnumber');
1421 $self->{all_payment_terms} = SL::DB::Manager::PaymentTerm->get_all_sorted(where => [ or => [ id => $self->order->payment_id,
1423 $self->{all_delivery_terms} = SL::DB::Manager::DeliveryTerm->get_all_sorted();
1424 $self->{current_employee_id} = SL::DB::Manager::Employee->current->id;
1425 $self->{periodic_invoices_status} = $self->_get_periodic_invoices_status($self->order->periodic_invoices_config);
1426 $self->{order_probabilities} = [ map { { title => ($_ * 10) . '%', id => $_ * 10 } } (0..10) ];
1428 my $print_form = Form->new('');
1429 $print_form->{type} = $self->type;
1430 $print_form->{printers} = SL::DB::Manager::Printer->get_all_sorted;
1431 $print_form->{languages} = SL::DB::Manager::Language->get_all_sorted;
1432 $self->{print_options} = SL::Helper::PrintOptions->get_print_options(
1433 form => $print_form,
1434 options => {dialog_name_prefix => 'print_options.',
1438 no_opendocument => 1,
1442 foreach my $item (@{$self->order->orderitems}) {
1443 my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
1444 $item->active_price_source( $price_source->price_from_source( $item->active_price_source ));
1445 $item->active_discount_source($price_source->discount_from_source($item->active_discount_source));
1448 if ($self->order->number && $::instance_conf->get_webdav) {
1449 my $webdav = SL::Webdav->new(
1450 type => $self->type,
1451 number => $self->order->number,
1453 my @all_objects = $webdav->get_all_objects;
1454 @{ $self->{template_args}->{WEBDAV} } = map { { name => $_->filename,
1456 link => File::Spec->catfile($_->full_filedescriptor),
1460 $::request->{layout}->use_javascript("${_}.js") for qw(kivi.SalesPurchase kivi.Order kivi.File ckeditor/ckeditor ckeditor/adapters/jquery edit_periodic_invoices_config calculate_qty);
1461 $self->_setup_edit_action_bar;
1464 sub _setup_edit_action_bar {
1465 my ($self, %params) = @_;
1467 my $deletion_allowed = (any { $self->type eq $_ } (_sales_quotation_type(), _request_quotation_type()))
1468 || (($self->type eq _sales_order_type()) && $::instance_conf->get_sales_order_show_delete)
1469 || (($self->type eq _purchase_order_type()) && $::instance_conf->get_purchase_order_show_delete);
1471 for my $bar ($::request->layout->get('actionbar')) {
1476 call => [ 'kivi.Order.save', 'save', $::instance_conf->get_order_warn_duplicate_parts,
1477 $::instance_conf->get_order_warn_no_deliverydate,
1479 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1483 call => [ 'kivi.Order.save', 'save_as_new', $::instance_conf->get_order_warn_duplicate_parts ],
1484 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1485 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1488 t8('Save and Delivery Order'),
1489 call => [ 'kivi.Order.save', 'save_and_delivery_order', $::instance_conf->get_order_warn_duplicate_parts,
1490 $::instance_conf->get_order_warn_no_deliverydate,
1492 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1493 only_if => (any { $self->type eq $_ } (_sales_order_type(), _purchase_order_type()))
1496 t8('Save and Invoice'),
1497 call => [ 'kivi.Order.save', 'save_and_invoice', $::instance_conf->get_order_warn_duplicate_parts ],
1498 checks => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1500 ], # end of combobox "Save"
1508 submit => [ '#order_form', { action => "Order/sales_order" } ],
1509 only_if => (any { $self->type eq $_ } (_sales_quotation_type(), _purchase_order_type())),
1510 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1513 t8('Purchase Order'),
1514 submit => [ '#order_form', { action => "Order/purchase_order" } ],
1515 only_if => (any { $self->type eq $_ } (_sales_order_type(), _request_quotation_type())),
1516 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1518 ], # end of combobox "Workflow"
1526 call => [ 'kivi.Order.show_print_options' ],
1530 call => [ 'kivi.Order.email' ],
1533 t8('Download attachments of all parts'),
1534 call => [ 'kivi.File.downloadOrderitemsFiles', $::form->{type}, $::form->{id} ],
1535 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1536 only_if => $::instance_conf->get_doc_storage,
1538 ], # end of combobox "Export"
1542 call => [ 'kivi.Order.delete_order' ],
1543 confirm => $::locale->text('Do you really want to delete this object?'),
1544 disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1545 only_if => $deletion_allowed,
1552 my ($order, $pdf_ref, $params) = @_;
1556 my $print_form = Form->new('');
1557 $print_form->{type} = $order->type;
1558 $print_form->{formname} = $params->{formname} || $order->type;
1559 $print_form->{format} = $params->{format} || 'pdf';
1560 $print_form->{media} = $params->{media} || 'file';
1561 $print_form->{groupitems} = $params->{groupitems};
1562 $print_form->{media} = 'file' if $print_form->{media} eq 'screen';
1564 $order->language($params->{language});
1565 $order->flatten_to_form($print_form, format_amounts => 1);
1567 # search for the template
1568 my ($template_file, @template_files) = SL::Helper::CreatePDF->find_template(
1569 name => $print_form->{formname},
1570 email => $print_form->{media} eq 'email',
1571 language => $params->{language},
1572 printer_id => $print_form->{printer_id}, # todo
1575 if (!defined $template_file) {
1576 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);
1579 return @errors if scalar @errors;
1581 $print_form->throw_on_error(sub {
1583 $print_form->prepare_for_printing;
1585 $$pdf_ref = SL::Helper::CreatePDF->create_pdf(
1586 template => $template_file,
1587 variables => $print_form,
1588 variable_content_types => {
1589 longdescription => 'html',
1590 partnotes => 'html',
1595 } || push @errors, ref($EVAL_ERROR) eq 'SL::X::FormError' ? $EVAL_ERROR->getMessage : $EVAL_ERROR;
1601 sub _get_files_for_email_dialog {
1604 my %files = map { ($_ => []) } qw(versions files vc_files part_files);
1606 return %files if !$::instance_conf->get_doc_storage;
1608 if ($self->order->id) {
1609 $files{versions} = [ SL::File->get_all_versions(object_id => $self->order->id, object_type => $self->order->type, file_type => 'document') ];
1610 $files{files} = [ SL::File->get_all( object_id => $self->order->id, object_type => $self->order->type, file_type => 'attachment') ];
1611 $files{vc_files} = [ SL::File->get_all( object_id => $self->order->{$self->cv}->id, object_type => $self->cv, file_type => 'attachment') ];
1615 uniq_by { $_->{id} }
1617 +{ id => $_->part->id,
1618 partnumber => $_->part->partnumber }
1619 } @{$self->order->items_sorted};
1621 foreach my $part (@parts) {
1622 my @pfiles = SL::File->get_all(object_id => $part->{id}, object_type => 'part');
1623 push @{ $files{part_files} }, map { +{ %{ $_ }, partnumber => $part->{partnumber} } } @pfiles;
1626 foreach my $key (keys %files) {
1627 $files{$key} = [ sort_by { lc $_->{db_file}->{file_name} } @{ $files{$key} } ];
1633 sub _make_periodic_invoices_config_from_yaml {
1634 my ($yaml_config) = @_;
1636 return if !$yaml_config;
1637 my $attr = YAML::Load($yaml_config);
1638 return if 'HASH' ne ref $attr;
1639 return SL::DB::PeriodicInvoicesConfig->new(%$attr);
1643 sub _get_periodic_invoices_status {
1644 my ($self, $config) = @_;
1646 return if $self->type ne _sales_order_type();
1647 return t8('not configured') if !$config;
1649 my $active = ('HASH' eq ref $config) ? $config->{active}
1650 : ('SL::DB::PeriodicInvoicesConfig' eq ref $config) ? $config->active
1651 : die "Cannot get status of periodic invoices config";
1653 return $active ? t8('active') : t8('inactive');
1656 sub _get_title_for {
1657 my ($self, $action) = @_;
1659 return '' if none { lc($action)} qw(add edit);
1662 # $::locale->text("Add Sales Order");
1663 # $::locale->text("Add Purchase Order");
1664 # $::locale->text("Add Quotation");
1665 # $::locale->text("Add Request for Quotation");
1666 # $::locale->text("Edit Sales Order");
1667 # $::locale->text("Edit Purchase Order");
1668 # $::locale->text("Edit Quotation");
1669 # $::locale->text("Edit Request for Quotation");
1671 $action = ucfirst(lc($action));
1672 return $self->type eq _sales_order_type() ? $::locale->text("$action Sales Order")
1673 : $self->type eq _purchase_order_type() ? $::locale->text("$action Purchase Order")
1674 : $self->type eq _sales_quotation_type() ? $::locale->text("$action Quotation")
1675 : $self->type eq _request_quotation_type() ? $::locale->text("$action Request for Quotation")
1679 sub _sales_order_type {
1683 sub _purchase_order_type {
1687 sub _sales_quotation_type {
1691 sub _request_quotation_type {
1692 'request_quotation';
1696 return $_[0]->type eq _sales_order_type() ? 'ordnumber'
1697 : $_[0]->type eq _purchase_order_type() ? 'ordnumber'
1698 : $_[0]->type eq _sales_quotation_type() ? 'quonumber'
1699 : $_[0]->type eq _request_quotation_type() ? 'quonumber'
1711 SL::Controller::Order - controller for orders
1715 This is a new form to enter orders, completely rewritten with the use
1716 of controller and java script techniques.
1718 The aim is to provide the user a better expirience and a faster flow
1719 of work. Also the code should be more readable, more reliable and
1728 One input row, so that input happens every time at the same place.
1732 Use of pickers where possible.
1736 Possibility to enter more than one item at once.
1740 Save order only on "save" (and "save and delivery order"-workflow). No
1741 hidden save on "print" or "email".
1745 Item list in a scrollable area, so that the workflow buttons stay at
1750 Reordering item rows with drag and drop is possible. Sorting item rows is
1751 possible (by partnumber, description, qty, sellprice and discount for now).
1755 No C<update> is necessary. All entries and calculations are managed
1756 with ajax-calls and the page does only reload on C<save>.
1760 User can see changes immediately, because of the use of java script
1771 =item * C<SL/Controller/Order.pm>
1775 =item * C<template/webpages/order/form.html>
1779 =item * C<template/webpages/order/tabs/basic_data.html>
1781 Main tab for basic_data.
1783 This is the only tab here for now. "linked records" and "webdav" tabs are
1784 reused from generic code.
1788 =item * C<template/webpages/order/tabs/_business_info_row.html>
1790 For displaying information on business type
1792 =item * C<template/webpages/order/tabs/_item_input.html>
1794 The input line for items
1796 =item * C<template/webpages/order/tabs/_row.html>
1798 One row for already entered items
1800 =item * C<template/webpages/order/tabs/_tax_row.html>
1802 Displaying tax information
1804 =item * C<template/webpages/order/tabs/_multi_items_dialog.html>
1806 Dialog for entering more than one item at once
1808 =item * C<template/webpages/order/tabs/_multi_items_result.html>
1810 Results for the filter in the multi items dialog
1812 =item * C<template/webpages/order/tabs/_price_sources_dialog.html>
1814 Dialog for selecting price and discount sources
1818 =item * C<js/kivi.Order.js>
1820 java script functions
1832 =item * credit limit
1834 =item * more workflows (save as new, quotation, purchase order)
1836 =item * price sources: little symbols showing better price / better discount
1838 =item * select units in input row?
1840 =item * custom shipto address
1842 =item * check for direct delivery (workflow sales order -> purchase order)
1844 =item * language / part translations
1846 =item * access rights
1848 =item * display weights
1854 =item * optional client/user behaviour
1856 (transactions has to be set - department has to be set -
1857 force project if enabled in client config - transport cost reminder)
1861 =head1 KNOWN BUGS AND CAVEATS
1867 Customer discount is not displayed as a valid discount in price source popup
1868 (this might be a bug in price sources)
1870 (I cannot reproduce this (Bernd))
1874 No indication that <shift>-up/down expands/collapses second row.
1878 Inline creation of parts is not currently supported
1882 Table header is not sticky in the scrolling area.
1886 Sorting does not include C<position>, neither does reordering.
1888 This behavior was implemented intentionally. But we can discuss, which behavior
1889 should be implemented.
1893 C<show_multi_items_dialog> does not use the currently inserted string for
1898 The language selected in print or email dialog is not saved when the order is saved.
1902 =head1 To discuss / Nice to have
1908 How to expand/collapse second row. Now it can be done clicking the icon or
1913 Possibility to change longdescription in input row?
1917 Possibility to select PriceSources in input row?
1921 This controller uses a (changed) copy of the template for the PriceSource
1922 dialog. Maybe there could be used one code source.
1926 Rounding-differences between this controller (PriceTaxCalculator) and the old
1927 form. This is not only a problem here, but also in all parts using the PTC.
1928 There exists a ticket and a patch. This patch should be testet.
1932 An indicator, if the actual inputs are saved (like in an
1933 editor or on text processing application).
1937 A warning when leaving the page without saveing unchanged inputs.
1941 Workflows for delivery order and invoice are in the menu "Save", because the
1942 order is saved before opening the new document form. Nevertheless perhaps these
1943 workflow buttons should be put under "Workflows".
1950 Bernd Bleßmann E<lt>bernd@kivitendo-premium.deE<gt>