Merge branch 'master' of github.com:kivitendo/kivitendo-erp
[kivitendo-erp.git] / SL / Controller / Order.pm
1 package SL::Controller::Order;
2
3 use strict;
4 use parent qw(SL::Controller::Base);
5
6 use SL::Helper::Flash qw(flash_later);
7 use SL::Presenter::Tag qw(select_tag hidden_tag div_tag);
8 use SL::Locale::String qw(t8);
9 use SL::SessionFile::Random;
10 use SL::PriceSource;
11 use SL::Webdav;
12 use SL::File;
13 use SL::MIME;
14 use SL::Util qw(trim);
15 use SL::YAML;
16 use SL::DB::Order;
17 use SL::DB::Default;
18 use SL::DB::Unit;
19 use SL::DB::Part;
20 use SL::DB::PartsGroup;
21 use SL::DB::Printer;
22 use SL::DB::Language;
23 use SL::DB::RecordLink;
24 use SL::DB::Shipto;
25
26 use SL::Helper::CreatePDF qw(:all);
27 use SL::Helper::PrintOptions;
28 use SL::Helper::ShippedQty;
29 use SL::Helper::UserPreferences::PositionsScrollbar;
30 use SL::Helper::UserPreferences::UpdatePositions;
31
32 use SL::Controller::Helper::GetModels;
33
34 use List::Util qw(first sum0);
35 use List::UtilsBy qw(sort_by uniq_by);
36 use List::MoreUtils qw(any none pairwise first_index);
37 use English qw(-no_match_vars);
38 use File::Spec;
39 use Cwd;
40 use Sort::Naturally;
41
42 use Rose::Object::MakeMethods::Generic
43 (
44  scalar => [ qw(item_ids_to_delete is_custom_shipto_to_delete) ],
45  'scalar --get_set_init' => [ qw(order valid_types type cv p multi_items_models all_price_factors search_cvpartnumber show_update_button) ],
46 );
47
48
49 # safety
50 __PACKAGE__->run_before('check_auth');
51
52 __PACKAGE__->run_before('recalc',
53                         only => [ qw(save save_as_new save_and_delivery_order save_and_invoice save_and_ap_transaction
54                                      print send_email) ]);
55
56 __PACKAGE__->run_before('get_unalterable_data',
57                         only => [ qw(save save_as_new save_and_delivery_order save_and_invoice save_and_ap_transaction
58                                      print send_email) ]);
59
60 #
61 # actions
62 #
63
64 # add a new order
65 sub action_add {
66   my ($self) = @_;
67
68   $self->order->transdate(DateTime->now_local());
69   my $extra_days = $self->{type} eq 'sales_quotation' ? $::instance_conf->get_reqdate_interval       :
70                    $self->{type} eq 'sales_order'     ? $::instance_conf->get_delivery_date_interval : 1;
71   $self->order->reqdate(DateTime->today_local->next_workday(extra_days => $extra_days)) if !$self->order->reqdate;
72
73
74   $self->pre_render();
75   $self->render(
76     'order/form',
77     title => $self->get_title_for('add'),
78     %{$self->{template_args}}
79   );
80 }
81
82 # edit an existing order
83 sub action_edit {
84   my ($self) = @_;
85
86   if ($::form->{id}) {
87     $self->load_order;
88
89   } else {
90     # this is to edit an order from an unsaved order object
91
92     # set item ids to new fake id, to identify them as new items
93     foreach my $item (@{$self->order->items_sorted}) {
94       $item->{new_fake_id} = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
95     }
96     # trigger rendering values for second row/longdescription as hidden,
97     # because they are loaded only on demand. So we need to keep the values
98     # from the source.
99     $_->{render_second_row}      = 1 for @{ $self->order->items_sorted };
100     $_->{render_longdescription} = 1 for @{ $self->order->items_sorted };
101   }
102
103   $self->recalc();
104   $self->pre_render();
105   $self->render(
106     'order/form',
107     title => $self->get_title_for('edit'),
108     %{$self->{template_args}}
109   );
110 }
111
112 # edit a collective order (consisting of one or more existing orders)
113 sub action_edit_collective {
114   my ($self) = @_;
115
116   # collect order ids
117   my @multi_ids = map {
118     $_ =~ m{^multi_id_(\d+)$} && $::form->{'multi_id_' . $1} && $::form->{'trans_id_' . $1} && $::form->{'trans_id_' . $1}
119   } grep { $_ =~ m{^multi_id_\d+$} } keys %$::form;
120
121   # fall back to add if no ids are given
122   if (scalar @multi_ids == 0) {
123     $self->action_add();
124     return;
125   }
126
127   # fall back to save as new if only one id is given
128   if (scalar @multi_ids == 1) {
129     $self->order(SL::DB::Order->new(id => $multi_ids[0])->load);
130     $self->action_save_as_new();
131     return;
132   }
133
134   # make new order from given orders
135   my @multi_orders = map { SL::DB::Order->new(id => $_)->load } @multi_ids;
136   $self->{converted_from_oe_id} = join ' ', map { $_->id } @multi_orders;
137   $self->order(SL::DB::Order->new_from_multi(\@multi_orders, sort_sources_by => 'transdate'));
138
139   $self->action_edit();
140 }
141
142 # delete the order
143 sub action_delete {
144   my ($self) = @_;
145
146   my $errors = $self->delete();
147
148   if (scalar @{ $errors }) {
149     $self->js->flash('error', $_) foreach @{ $errors };
150     return $self->js->render();
151   }
152
153   my $text = $self->type eq sales_order_type()       ? $::locale->text('The order has been deleted')
154            : $self->type eq purchase_order_type()    ? $::locale->text('The order has been deleted')
155            : $self->type eq sales_quotation_type()   ? $::locale->text('The quotation has been deleted')
156            : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been deleted')
157            : '';
158   flash_later('info', $text);
159
160   my @redirect_params = (
161     action => 'add',
162     type   => $self->type,
163   );
164
165   $self->redirect_to(@redirect_params);
166 }
167
168 # save the order
169 sub action_save {
170   my ($self) = @_;
171
172   my $errors = $self->save();
173
174   if (scalar @{ $errors }) {
175     $self->js->flash('error', $_) foreach @{ $errors };
176     return $self->js->render();
177   }
178
179   my $text = $self->type eq sales_order_type()       ? $::locale->text('The order has been saved')
180            : $self->type eq purchase_order_type()    ? $::locale->text('The order has been saved')
181            : $self->type eq sales_quotation_type()   ? $::locale->text('The quotation has been saved')
182            : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
183            : '';
184   flash_later('info', $text);
185
186   my @redirect_params = (
187     action => 'edit',
188     type   => $self->type,
189     id     => $self->order->id,
190   );
191
192   $self->redirect_to(@redirect_params);
193 }
194
195 # save the order as new document an open it for edit
196 sub action_save_as_new {
197   my ($self) = @_;
198
199   my $order = $self->order;
200
201   if (!$order->id) {
202     $self->js->flash('error', t8('This object has not been saved yet.'));
203     return $self->js->render();
204   }
205
206   # load order from db to check if values changed
207   my $saved_order = SL::DB::Order->new(id => $order->id)->load;
208
209   my %new_attrs;
210   # Lets assign a new number if the user hasn't changed the previous one.
211   # If it has been changed manually then use it as-is.
212   $new_attrs{number}    = (trim($order->number) eq $saved_order->number)
213                         ? ''
214                         : trim($order->number);
215
216   # Clear transdate unless changed
217   $new_attrs{transdate} = ($order->transdate == $saved_order->transdate)
218                         ? DateTime->today_local
219                         : $order->transdate;
220
221   # Set new reqdate unless changed
222   if ($order->reqdate == $saved_order->reqdate) {
223     my $extra_days = $self->{type} eq 'sales_quotation' ? $::instance_conf->get_reqdate_interval       :
224                      $self->{type} eq 'sales_order'     ? $::instance_conf->get_delivery_date_interval : 1;
225     $new_attrs{reqdate} = DateTime->today_local->next_workday(extra_days => $extra_days);
226   } else {
227     $new_attrs{reqdate} = $order->reqdate;
228   }
229
230   # Update employee
231   $new_attrs{employee}  = SL::DB::Manager::Employee->current;
232
233   # Create new record from current one
234   $self->order(SL::DB::Order->new_from($order, destination_type => $order->type, attributes => \%new_attrs));
235
236   # no linked records on save as new
237   delete $::form->{$_} for qw(converted_from_oe_id converted_from_orderitems_ids);
238
239   # save
240   $self->action_save();
241 }
242
243 # print the order
244 #
245 # This is called if "print" is pressed in the print dialog.
246 # If PDF creation was requested and succeeded, the pdf is offered for download
247 # via send_file (which uses ajax in this case).
248 sub action_print {
249   my ($self) = @_;
250
251   my $errors = $self->save();
252
253   if (scalar @{ $errors }) {
254     $self->js->flash('error', $_) foreach @{ $errors };
255     return $self->js->render();
256   }
257
258   $self->js_reset_order_and_item_ids_after_save;
259
260   my $format      = $::form->{print_options}->{format};
261   my $media       = $::form->{print_options}->{media};
262   my $formname    = $::form->{print_options}->{formname};
263   my $copies      = $::form->{print_options}->{copies};
264   my $groupitems  = $::form->{print_options}->{groupitems};
265
266   # only pdf and opendocument by now
267   if (none { $format eq $_ } qw(pdf opendocument opendocument_pdf)) {
268     return $self->js->flash('error', t8('Format \'#1\' is not supported yet/anymore.', $format))->render;
269   }
270
271   # only screen or printer by now
272   if (none { $media eq $_ } qw(screen printer)) {
273     return $self->js->flash('error', t8('Media \'#1\' is not supported yet/anymore.', $media))->render;
274   }
275
276   my $language;
277   $language = SL::DB::Language->new(id => $::form->{print_options}->{language_id})->load if $::form->{print_options}->{language_id};
278
279   # create a form for generate_attachment_filename
280   my $form   = Form->new;
281   $form->{$self->nr_key()}  = $self->order->number;
282   $form->{type}             = $self->type;
283   $form->{format}           = $format;
284   $form->{formname}         = $formname;
285   $form->{language}         = '_' . $language->template_code if $language;
286   my $pdf_filename          = $form->generate_attachment_filename();
287
288   my $pdf;
289   my @errors = generate_pdf($self->order, \$pdf, { format     => $format,
290                                                    formname   => $formname,
291                                                    language   => $language,
292                                                    groupitems => $groupitems });
293   if (scalar @errors) {
294     return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render;
295   }
296
297   if ($media eq 'screen') {
298     # screen/download
299     $self->js->flash('info', t8('The PDF has been created'));
300     $self->send_file(
301       \$pdf,
302       type         => SL::MIME->mime_type_from_ext($pdf_filename),
303       name         => $pdf_filename,
304       js_no_render => 1,
305     );
306
307   } elsif ($media eq 'printer') {
308     # printer
309     my $printer_id = $::form->{print_options}->{printer_id};
310     SL::DB::Printer->new(id => $printer_id)->load->print_document(
311       copies  => $copies,
312       content => $pdf,
313     );
314
315     $self->js->flash('info', t8('The PDF has been printed'));
316   }
317
318   # copy file to webdav folder
319   if ($self->order->number && $::instance_conf->get_webdav_documents) {
320     my $webdav = SL::Webdav->new(
321       type     => $self->type,
322       number   => $self->order->number,
323     );
324     my $webdav_file = SL::Webdav::File->new(
325       webdav   => $webdav,
326       filename => $pdf_filename,
327     );
328     eval {
329       $webdav_file->store(data => \$pdf);
330       1;
331     } or do {
332       $self->js->flash('error', t8('Storing PDF to webdav folder failed: #1', $@));
333     }
334   }
335   if ($self->order->number && $::instance_conf->get_doc_storage) {
336     eval {
337       SL::File->save(object_id     => $self->order->id,
338                      object_type   => $self->type,
339                      mime_type     => 'application/pdf',
340                      source        => 'created',
341                      file_type     => 'document',
342                      file_name     => $pdf_filename,
343                      file_contents => $pdf);
344       1;
345     } or do {
346       $self->js->flash('error', t8('Storing PDF in storage backend failed: #1', $@));
347     }
348   }
349   $self->js->render;
350 }
351
352 # open the email dialog
353 sub action_show_email_dialog {
354   my ($self) = @_;
355
356   my $cv_method = $self->cv;
357
358   if (!$self->order->$cv_method) {
359     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'))
360                     ->render($self);
361   }
362
363   my $email_form;
364   $email_form->{to}   = $self->order->contact->cp_email if $self->order->contact;
365   $email_form->{to} ||= $self->order->$cv_method->email;
366   $email_form->{cc}   = $self->order->$cv_method->cc;
367   $email_form->{bcc}  = join ', ', grep $_, $self->order->$cv_method->bcc, SL::DB::Default->get->global_bcc;
368   # Todo: get addresses from shipto, if any
369
370   my $form = Form->new;
371   $form->{$self->nr_key()}  = $self->order->number;
372   $form->{formname}         = $self->type;
373   $form->{type}             = $self->type;
374   $form->{language}         = '_' . $self->order->language->template_code if $self->order->language;
375   $form->{language_id}      = $self->order->language->id                  if $self->order->language;
376   $form->{cusordnumber}     = $self->order->cusordnumber;
377   $form->{format}           = 'pdf';
378
379   $email_form->{subject}             = $form->generate_email_subject();
380   $email_form->{attachment_filename} = $form->generate_attachment_filename();
381   $email_form->{message}             = $form->generate_email_body();
382   $email_form->{js_send_function}    = 'kivi.Order.send_email()';
383
384   my %files = $self->get_files_for_email_dialog();
385   my $dialog_html = $self->render('common/_send_email_dialog', { output => 0 },
386                                   email_form  => $email_form,
387                                   show_bcc    => $::auth->assert('email_bcc', 'may fail'),
388                                   FILES       => \%files,
389                                   is_customer => $self->cv eq 'customer',
390   );
391
392   $self->js
393       ->run('kivi.Order.show_email_dialog', $dialog_html)
394       ->reinit_widgets
395       ->render($self);
396 }
397
398 # send email
399 #
400 # Todo: handling error messages: flash is not displayed in dialog, but in the main form
401 sub action_send_email {
402   my ($self) = @_;
403
404   my $errors = $self->save();
405
406   if (scalar @{ $errors }) {
407     $self->js->run('kivi.Order.close_email_dialog');
408     $self->js->flash('error', $_) foreach @{ $errors };
409     return $self->js->render();
410   }
411
412   $self->js_reset_order_and_item_ids_after_save;
413
414   my $email_form  = delete $::form->{email_form};
415   my %field_names = (to => 'email');
416
417   $::form->{ $field_names{$_} // $_ } = $email_form->{$_} for keys %{ $email_form };
418
419   # for Form::cleanup which may be called in Form::send_email
420   $::form->{cwd}    = getcwd();
421   $::form->{tmpdir} = $::lx_office_conf{paths}->{userspath};
422
423   $::form->{$_}     = $::form->{print_options}->{$_} for keys %{ $::form->{print_options} };
424   $::form->{media}  = 'email';
425
426   if (($::form->{attachment_policy} // '') !~ m{^(?:old_file|no_file)$}) {
427     my $language;
428     $language = SL::DB::Language->new(id => $::form->{print_options}->{language_id})->load if $::form->{print_options}->{language_id};
429
430     my $pdf;
431     my @errors = generate_pdf($self->order, \$pdf, {media      => $::form->{media},
432                                                     format     => $::form->{print_options}->{format},
433                                                     formname   => $::form->{print_options}->{formname},
434                                                     language   => $language,
435                                                     groupitems => $::form->{print_options}->{groupitems}});
436     if (scalar @errors) {
437       return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
438     }
439
440     my $sfile = SL::SessionFile::Random->new(mode => "w");
441     $sfile->fh->print($pdf);
442     $sfile->fh->close;
443
444     $::form->{tmpfile} = $sfile->file_name;
445     $::form->{tmpdir}  = $sfile->get_path; # for Form::cleanup which may be called in Form::send_email
446   }
447
448   $::form->send_email(\%::myconfig, 'pdf');
449
450   # internal notes
451   my $intnotes = $self->order->intnotes;
452   $intnotes   .= "\n\n" if $self->order->intnotes;
453   $intnotes   .= t8('[email]')                                                                                        . "\n";
454   $intnotes   .= t8('Date')       . ": " . $::locale->format_date_object(DateTime->now_local, precision => 'seconds') . "\n";
455   $intnotes   .= t8('To (email)') . ": " . $::form->{email}                                                           . "\n";
456   $intnotes   .= t8('Cc')         . ": " . $::form->{cc}                                                              . "\n"    if $::form->{cc};
457   $intnotes   .= t8('Bcc')        . ": " . $::form->{bcc}                                                             . "\n"    if $::form->{bcc};
458   $intnotes   .= t8('Subject')    . ": " . $::form->{subject}                                                         . "\n\n";
459   $intnotes   .= t8('Message')    . ": " . $::form->{message};
460
461   $self->order->update_attributes(intnotes => $intnotes);
462
463   $self->js
464       ->val('#order_intnotes', $intnotes)
465       ->run('kivi.Order.close_email_dialog')
466       ->flash('info', t8('The email has been sent.'))
467       ->render($self);
468 }
469
470 # open the periodic invoices config dialog
471 #
472 # If there are values in the form (i.e. dialog was opened before),
473 # then use this values. Create new ones, else.
474 sub action_show_periodic_invoices_config_dialog {
475   my ($self) = @_;
476
477   my $config = make_periodic_invoices_config_from_yaml(delete $::form->{config});
478   $config  ||= SL::DB::Manager::PeriodicInvoicesConfig->find_by(oe_id => $::form->{id}) if $::form->{id};
479   $config  ||= SL::DB::PeriodicInvoicesConfig->new(periodicity             => 'm',
480                                                    order_value_periodicity => 'p', # = same as periodicity
481                                                    start_date_as_date      => $::form->{transdate_as_date} || $::form->current_date,
482                                                    extend_automatically_by => 12,
483                                                    active                  => 1,
484                                                    email_subject           => GenericTranslations->get(
485                                                                                 language_id      => $::form->{language_id},
486                                                                                 translation_type =>"preset_text_periodic_invoices_email_subject"),
487                                                    email_body              => GenericTranslations->get(
488                                                                                 language_id      => $::form->{language_id},
489                                                                                 translation_type =>"preset_text_periodic_invoices_email_body"),
490   );
491   $config->periodicity('m')             if none { $_ eq $config->periodicity             }       @SL::DB::PeriodicInvoicesConfig::PERIODICITIES;
492   $config->order_value_periodicity('p') if none { $_ eq $config->order_value_periodicity } ('p', @SL::DB::PeriodicInvoicesConfig::ORDER_VALUE_PERIODICITIES);
493
494   $::form->get_lists(printers => "ALL_PRINTERS",
495                      charts   => { key       => 'ALL_CHARTS',
496                                    transdate => 'current_date' });
497
498   $::form->{AR} = [ grep { $_->{link} =~ m/(?:^|:)AR(?::|$)/ } @{ $::form->{ALL_CHARTS} } ];
499
500   if ($::form->{customer_id}) {
501     $::form->{ALL_CONTACTS} = SL::DB::Manager::Contact->get_all_sorted(where => [ cp_cv_id => $::form->{customer_id} ]);
502     $::form->{email_recipient_invoice_address} = SL::DB::Manager::Customer->find_by(id => $::form->{customer_id})->invoice_mail;
503   }
504
505   $self->render('oe/edit_periodic_invoices_config', { layout => 0 },
506                 popup_dialog             => 1,
507                 popup_js_close_function  => 'kivi.Order.close_periodic_invoices_config_dialog()',
508                 popup_js_assign_function => 'kivi.Order.assign_periodic_invoices_config()',
509                 config                   => $config,
510                 %$::form);
511 }
512
513 # assign the values of the periodic invoices config dialog
514 # as yaml in the hidden tag and set the status.
515 sub action_assign_periodic_invoices_config {
516   my ($self) = @_;
517
518   $::form->isblank('start_date_as_date', $::locale->text('The start date is missing.'));
519
520   my $config = { active                     => $::form->{active}       ? 1 : 0,
521                  terminated                 => $::form->{terminated}   ? 1 : 0,
522                  direct_debit               => $::form->{direct_debit} ? 1 : 0,
523                  periodicity                => (any { $_ eq $::form->{periodicity}             }       @SL::DB::PeriodicInvoicesConfig::PERIODICITIES)              ? $::form->{periodicity}             : 'm',
524                  order_value_periodicity    => (any { $_ eq $::form->{order_value_periodicity} } ('p', @SL::DB::PeriodicInvoicesConfig::ORDER_VALUE_PERIODICITIES)) ? $::form->{order_value_periodicity} : 'p',
525                  start_date_as_date         => $::form->{start_date_as_date},
526                  end_date_as_date           => $::form->{end_date_as_date},
527                  first_billing_date_as_date => $::form->{first_billing_date_as_date},
528                  print                      => $::form->{print}      ? 1                         : 0,
529                  printer_id                 => $::form->{print}      ? $::form->{printer_id} * 1 : undef,
530                  copies                     => $::form->{copies} * 1 ? $::form->{copies}         : 1,
531                  extend_automatically_by    => $::form->{extend_automatically_by}    * 1 || undef,
532                  ar_chart_id                => $::form->{ar_chart_id} * 1,
533                  send_email                 => $::form->{send_email} ? 1 : 0,
534                  email_recipient_contact_id => $::form->{email_recipient_contact_id} * 1 || undef,
535                  email_recipient_address    => $::form->{email_recipient_address},
536                  email_sender               => $::form->{email_sender},
537                  email_subject              => $::form->{email_subject},
538                  email_body                 => $::form->{email_body},
539                };
540
541   my $periodic_invoices_config = SL::YAML::Dump($config);
542
543   my $status = $self->get_periodic_invoices_status($config);
544
545   $self->js
546     ->remove('#order_periodic_invoices_config')
547     ->insertAfter(hidden_tag('order.periodic_invoices_config', $periodic_invoices_config), '#periodic_invoices_status')
548     ->run('kivi.Order.close_periodic_invoices_config_dialog')
549     ->html('#periodic_invoices_status', $status)
550     ->flash('info', t8('The periodic invoices config has been assigned.'))
551     ->render($self);
552 }
553
554 sub action_get_has_active_periodic_invoices {
555   my ($self) = @_;
556
557   my $config = make_periodic_invoices_config_from_yaml(delete $::form->{config});
558   $config  ||= SL::DB::Manager::PeriodicInvoicesConfig->find_by(oe_id => $::form->{id}) if $::form->{id};
559
560   my $has_active_periodic_invoices =
561        $self->type eq sales_order_type()
562     && $config
563     && $config->active
564     && (!$config->end_date || ($config->end_date > DateTime->today_local))
565     && $config->get_previous_billed_period_start_date;
566
567   $_[0]->render(\ !!$has_active_periodic_invoices, { type => 'text' });
568 }
569
570 # save the order and redirect to the frontend subroutine for a new
571 # delivery order
572 sub action_save_and_delivery_order {
573   my ($self) = @_;
574
575   my $errors = $self->save();
576
577   if (scalar @{ $errors }) {
578     $self->js->flash('error', $_) foreach @{ $errors };
579     return $self->js->render();
580   }
581
582   my $text = $self->type eq sales_order_type()       ? $::locale->text('The order has been saved')
583            : $self->type eq purchase_order_type()    ? $::locale->text('The order has been saved')
584            : $self->type eq sales_quotation_type()   ? $::locale->text('The quotation has been saved')
585            : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
586            : '';
587   flash_later('info', $text);
588
589   my @redirect_params = (
590     controller => 'oe.pl',
591     action     => 'oe_delivery_order_from_order',
592     id         => $self->order->id,
593   );
594
595   $self->redirect_to(@redirect_params);
596 }
597
598 # save the order and redirect to the frontend subroutine for a new
599 # invoice
600 sub action_save_and_invoice {
601   my ($self) = @_;
602
603   my $errors = $self->save();
604
605   if (scalar @{ $errors }) {
606     $self->js->flash('error', $_) foreach @{ $errors };
607     return $self->js->render();
608   }
609
610   my $text = $self->type eq sales_order_type()       ? $::locale->text('The order has been saved')
611            : $self->type eq purchase_order_type()    ? $::locale->text('The order has been saved')
612            : $self->type eq sales_quotation_type()   ? $::locale->text('The quotation has been saved')
613            : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
614            : '';
615   flash_later('info', $text);
616
617   my @redirect_params = (
618     controller => 'oe.pl',
619     action     => 'oe_invoice_from_order',
620     id         => $self->order->id,
621   );
622
623   $self->redirect_to(@redirect_params);
624 }
625
626 # workflow from sales quotation to sales order
627 sub action_sales_order {
628   $_[0]->workflow_sales_or_purchase_order();
629 }
630
631 # workflow from rfq to purchase order
632 sub action_purchase_order {
633   $_[0]->workflow_sales_or_purchase_order();
634 }
635
636 # workflow from purchase order to ap transaction
637 sub action_save_and_ap_transaction {
638   my ($self) = @_;
639
640   my $errors = $self->save();
641
642   if (scalar @{ $errors }) {
643     $self->js->flash('error', $_) foreach @{ $errors };
644     return $self->js->render();
645   }
646
647   my $text = $self->type eq sales_order_type()       ? $::locale->text('The order has been saved')
648            : $self->type eq purchase_order_type()    ? $::locale->text('The order has been saved')
649            : $self->type eq sales_quotation_type()   ? $::locale->text('The quotation has been saved')
650            : $self->type eq request_quotation_type() ? $::locale->text('The rfq has been saved')
651            : '';
652   flash_later('info', $text);
653
654   my @redirect_params = (
655     controller => 'ap.pl',
656     action     => 'add_from_purchase_order',
657     id         => $self->order->id,
658   );
659
660   $self->redirect_to(@redirect_params);
661 }
662
663 # set form elements in respect to a changed customer or vendor
664 #
665 # This action is called on an change of the customer/vendor picker.
666 sub action_customer_vendor_changed {
667   my ($self) = @_;
668
669   setup_order_from_cv($self->order);
670   $self->recalc();
671
672   my $cv_method = $self->cv;
673
674   if ($self->order->$cv_method->contacts && scalar @{ $self->order->$cv_method->contacts } > 0) {
675     $self->js->show('#cp_row');
676   } else {
677     $self->js->hide('#cp_row');
678   }
679
680   if ($self->order->$cv_method->shipto && scalar @{ $self->order->$cv_method->shipto } > 0) {
681     $self->js->show('#shipto_selection');
682   } else {
683     $self->js->hide('#shipto_selection');
684   }
685
686   $self->js->val( '#order_salesman_id',      $self->order->salesman_id)        if $self->order->is_sales;
687
688   $self->js
689     ->replaceWith('#order_cp_id',            $self->build_contact_select)
690     ->replaceWith('#order_shipto_id',        $self->build_shipto_select)
691     ->replaceWith('#shipto_inputs  ',        $self->build_shipto_inputs)
692     ->replaceWith('#business_info_row',      $self->build_business_info_row)
693     ->val(        '#order_taxzone_id',       $self->order->taxzone_id)
694     ->val(        '#order_taxincluded',      $self->order->taxincluded)
695     ->val(        '#order_currency_id',      $self->order->currency_id)
696     ->val(        '#order_payment_id',       $self->order->payment_id)
697     ->val(        '#order_delivery_term_id', $self->order->delivery_term_id)
698     ->val(        '#order_intnotes',         $self->order->intnotes)
699     ->val(        '#language_id',            $self->order->$cv_method->language_id)
700     ->focus(      '#order_' . $self->cv . '_id')
701     ->run('kivi.Order.update_exchangerate');
702
703   $self->js_redisplay_amounts_and_taxes;
704   $self->js_redisplay_cvpartnumbers;
705   $self->js->render();
706 }
707
708 # open the dialog for customer/vendor details
709 sub action_show_customer_vendor_details_dialog {
710   my ($self) = @_;
711
712   my $is_customer = 'customer' eq $::form->{vc};
713   my $cv;
714   if ($is_customer) {
715     $cv = SL::DB::Customer->new(id => $::form->{vc_id})->load;
716   } else {
717     $cv = SL::DB::Vendor->new(id => $::form->{vc_id})->load;
718   }
719
720   my %details = map { $_ => $cv->$_ } @{$cv->meta->columns};
721   $details{discount_as_percent} = $cv->discount_as_percent;
722   $details{creditlimt}          = $cv->creditlimit_as_number;
723   $details{business}            = $cv->business->description      if $cv->business;
724   $details{language}            = $cv->language_obj->description  if $cv->language_obj;
725   $details{delivery_terms}      = $cv->delivery_term->description if $cv->delivery_term;
726   $details{payment_terms}       = $cv->payment->description       if $cv->payment;
727   $details{pricegroup}          = $cv->pricegroup->pricegroup     if $is_customer && $cv->pricegroup;
728
729   foreach my $entry (@{ $cv->shipto }) {
730     push @{ $details{SHIPTO} },   { map { $_ => $entry->$_ } @{$entry->meta->columns} };
731   }
732   foreach my $entry (@{ $cv->contacts }) {
733     push @{ $details{CONTACTS} }, { map { $_ => $entry->$_ } @{$entry->meta->columns} };
734   }
735
736   $_[0]->render('common/show_vc_details', { layout => 0 },
737                 is_customer => $is_customer,
738                 %details);
739
740 }
741
742 # called if a unit in an existing item row is changed
743 sub action_unit_changed {
744   my ($self) = @_;
745
746   my $idx  = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
747   my $item = $self->order->items_sorted->[$idx];
748
749   my $old_unit_obj = SL::DB::Unit->new(name => $::form->{old_unit})->load;
750   $item->sellprice($item->unit_obj->convert_to($item->sellprice, $old_unit_obj));
751
752   $self->recalc();
753
754   $self->js
755     ->run('kivi.Order.update_sellprice', $::form->{item_id}, $item->sellprice_as_number);
756   $self->js_redisplay_line_values;
757   $self->js_redisplay_amounts_and_taxes;
758   $self->js->render();
759 }
760
761 # add an item row for a new item entered in the input row
762 sub action_add_item {
763   my ($self) = @_;
764
765   my $form_attr = $::form->{add_item};
766
767   return unless $form_attr->{parts_id};
768
769   my $item = new_item($self->order, $form_attr);
770
771   $self->order->add_items($item);
772
773   $self->recalc();
774
775   $self->get_item_cvpartnumber($item);
776
777   my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
778   my $row_as_html = $self->p->render('order/tabs/_row',
779                                      ITEM => $item,
780                                      ID   => $item_id,
781                                      SELF => $self,
782   );
783
784   if ($::form->{insert_before_item_id}) {
785     $self->js
786       ->before ('.row_entry:has(#item_' . $::form->{insert_before_item_id} . ')', $row_as_html);
787   } else {
788     $self->js
789       ->append('#row_table_id', $row_as_html);
790   }
791
792   if ( $item->part->is_assortment ) {
793     $form_attr->{qty_as_number} = 1 unless $form_attr->{qty_as_number};
794     foreach my $assortment_item ( @{$item->part->assortment_items} ) {
795       my $attr = { parts_id => $assortment_item->parts_id,
796                    qty      => $assortment_item->qty * $::form->parse_amount(\%::myconfig, $form_attr->{qty_as_number}), # TODO $form_attr->{unit}
797                    unit     => $assortment_item->unit,
798                    description => $assortment_item->part->description,
799                  };
800       my $item = new_item($self->order, $attr);
801
802       # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount
803       $item->discount(1) unless $assortment_item->charge;
804
805       $self->order->add_items( $item );
806       $self->recalc();
807       $self->get_item_cvpartnumber($item);
808       my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
809       my $row_as_html = $self->p->render('order/tabs/_row',
810                                          ITEM => $item,
811                                          ID   => $item_id,
812                                          SELF => $self,
813       );
814       if ($::form->{insert_before_item_id}) {
815         $self->js
816           ->before ('.row_entry:has(#item_' . $::form->{insert_before_item_id} . ')', $row_as_html);
817       } else {
818         $self->js
819           ->append('#row_table_id', $row_as_html);
820       }
821     };
822   };
823
824   $self->js
825     ->val('.add_item_input', '')
826     ->run('kivi.Order.init_row_handlers')
827     ->run('kivi.Order.renumber_positions')
828     ->focus('#add_item_parts_id_name');
829
830   $self->js->run('kivi.Order.row_table_scroll_down') if !$::form->{insert_before_item_id};
831
832   $self->js_redisplay_amounts_and_taxes;
833   $self->js->render();
834 }
835
836 # open the dialog for entering multiple items at once
837 sub action_show_multi_items_dialog {
838   $_[0]->render('order/tabs/_multi_items_dialog', { layout => 0 },
839                 all_partsgroups => SL::DB::Manager::PartsGroup->get_all);
840 }
841
842 # update the filter results in the multi item dialog
843 sub action_multi_items_update_result {
844   my $max_count = 100;
845
846   $::form->{multi_items}->{filter}->{obsolete} = 0;
847
848   my $count = $_[0]->multi_items_models->count;
849
850   if ($count == 0) {
851     my $text = SL::Presenter::EscapedText->new(text => $::locale->text('No results.'));
852     $_[0]->render($text, { layout => 0 });
853   } elsif ($count > $max_count) {
854     my $text = SL::Presenter::EscapedText->new(text => $::locale->text('Too many results (#1 from #2).', $count, $max_count));
855     $_[0]->render($text, { layout => 0 });
856   } else {
857     my $multi_items = $_[0]->multi_items_models->get;
858     $_[0]->render('order/tabs/_multi_items_result', { layout => 0 },
859                   multi_items => $multi_items);
860   }
861 }
862
863 # add item rows for multiple items at once
864 sub action_add_multi_items {
865   my ($self) = @_;
866
867   my @form_attr = grep { $_->{qty_as_number} } @{ $::form->{add_multi_items} };
868   return $self->js->render() unless scalar @form_attr;
869
870   my @items;
871   foreach my $attr (@form_attr) {
872     my $item = new_item($self->order, $attr);
873     push @items, $item;
874     if ( $item->part->is_assortment ) {
875       foreach my $assortment_item ( @{$item->part->assortment_items} ) {
876         my $attr = { parts_id => $assortment_item->parts_id,
877                      qty      => $assortment_item->qty * $item->qty, # TODO $form_attr->{unit}
878                      unit     => $assortment_item->unit,
879                      description => $assortment_item->part->description,
880                    };
881         my $item = new_item($self->order, $attr);
882
883         # set discount to 100% if item isn't supposed to be charged, overwriting any customer discount
884         $item->discount(1) unless $assortment_item->charge;
885         push @items, $item;
886       }
887     }
888   }
889   $self->order->add_items(@items);
890
891   $self->recalc();
892
893   foreach my $item (@items) {
894     $self->get_item_cvpartnumber($item);
895     my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
896     my $row_as_html = $self->p->render('order/tabs/_row',
897                                        ITEM => $item,
898                                        ID   => $item_id,
899                                        SELF => $self,
900     );
901
902     if ($::form->{insert_before_item_id}) {
903       $self->js
904         ->before ('.row_entry:has(#item_' . $::form->{insert_before_item_id} . ')', $row_as_html);
905     } else {
906       $self->js
907         ->append('#row_table_id', $row_as_html);
908     }
909   }
910
911   $self->js
912     ->run('kivi.Order.close_multi_items_dialog')
913     ->run('kivi.Order.init_row_handlers')
914     ->run('kivi.Order.renumber_positions')
915     ->focus('#add_item_parts_id_name');
916
917   $self->js->run('kivi.Order.row_table_scroll_down') if !$::form->{insert_before_item_id};
918
919   $self->js_redisplay_amounts_and_taxes;
920   $self->js->render();
921 }
922
923 # recalculate all linetotals, amounts and taxes and redisplay them
924 sub action_recalc_amounts_and_taxes {
925   my ($self) = @_;
926
927   $self->recalc();
928
929   $self->js_redisplay_line_values;
930   $self->js_redisplay_amounts_and_taxes;
931   $self->js->render();
932 }
933
934 sub action_update_exchangerate {
935   my ($self) = @_;
936
937   my $data = {
938     is_standard   => $self->order->currency_id == $::instance_conf->get_currency_id,
939     currency_name => $self->order->currency->name,
940     exchangerate  => $self->order->daily_exchangerate_as_null_number,
941   };
942
943   $self->render(\SL::JSON::to_json($data), { type => 'json', process => 0 });
944 }
945
946 # redisplay item rows if they are sorted by an attribute
947 sub action_reorder_items {
948   my ($self) = @_;
949
950   my %sort_keys = (
951     partnumber   => sub { $_[0]->part->partnumber },
952     description  => sub { $_[0]->description },
953     qty          => sub { $_[0]->qty },
954     sellprice    => sub { $_[0]->sellprice },
955     discount     => sub { $_[0]->discount },
956     cvpartnumber => sub { $_[0]->{cvpartnumber} },
957   );
958
959   $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
960
961   my $method = $sort_keys{$::form->{order_by}};
962   my @to_sort = map { { old_pos => $_->position, order_by => $method->($_) } } @{ $self->order->items_sorted };
963   if ($::form->{sort_dir}) {
964     if ( $::form->{order_by} =~ m/qty|sellprice|discount/ ){
965       @to_sort = sort { $a->{order_by} <=> $b->{order_by} } @to_sort;
966     } else {
967       @to_sort = sort { $a->{order_by} cmp $b->{order_by} } @to_sort;
968     }
969   } else {
970     if ( $::form->{order_by} =~ m/qty|sellprice|discount/ ){
971       @to_sort = sort { $b->{order_by} <=> $a->{order_by} } @to_sort;
972     } else {
973       @to_sort = sort { $b->{order_by} cmp $a->{order_by} } @to_sort;
974     }
975   }
976   $self->js
977     ->run('kivi.Order.redisplay_items', \@to_sort)
978     ->render;
979 }
980
981 # show the popup to choose a price/discount source
982 sub action_price_popup {
983   my ($self) = @_;
984
985   my $idx  = first_index { $_ eq $::form->{item_id} } @{ $::form->{orderitem_ids} };
986   my $item = $self->order->items_sorted->[$idx];
987
988   $self->render_price_dialog($item);
989 }
990
991 # get the longdescription for an item if the dialog to enter/change the
992 # longdescription was opened and the longdescription is empty
993 #
994 # If this item is new, get the longdescription from Part.
995 # Otherwise get it from OrderItem.
996 sub action_get_item_longdescription {
997   my $longdescription;
998
999   if ($::form->{item_id}) {
1000     $longdescription = SL::DB::OrderItem->new(id => $::form->{item_id})->load->longdescription;
1001   } elsif ($::form->{parts_id}) {
1002     $longdescription = SL::DB::Part->new(id => $::form->{parts_id})->load->notes;
1003   }
1004   $_[0]->render(\ $longdescription, { type => 'text' });
1005 }
1006
1007 # load the second row for one or more items
1008 #
1009 # This action gets the html code for all items second rows by rendering a template for
1010 # the second row and sets the html code via client js.
1011 sub action_load_second_rows {
1012   my ($self) = @_;
1013
1014   $self->recalc() if $self->order->is_sales; # for margin calculation
1015
1016   foreach my $item_id (@{ $::form->{item_ids} }) {
1017     my $idx  = first_index { $_ eq $item_id } @{ $::form->{orderitem_ids} };
1018     my $item = $self->order->items_sorted->[$idx];
1019
1020     $self->js_load_second_row($item, $item_id, 0);
1021   }
1022
1023   $self->js->run('kivi.Order.init_row_handlers') if $self->order->is_sales; # for lastcosts change-callback
1024
1025   $self->js->render();
1026 }
1027
1028 # update description, notes and sellprice from master data
1029 sub action_update_row_from_master_data {
1030   my ($self) = @_;
1031
1032   foreach my $item_id (@{ $::form->{item_ids} }) {
1033     my $idx  = first_index { $_ eq $item_id } @{ $::form->{orderitem_ids} };
1034     my $item = $self->order->items_sorted->[$idx];
1035
1036     $item->description($item->part->description);
1037     $item->longdescription($item->part->notes);
1038
1039     my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
1040
1041     my $price_src;
1042     if ($item->part->is_assortment) {
1043     # add assortment items with price 0, as the components carry the price
1044       $price_src = $price_source->price_from_source("");
1045       $price_src->price(0);
1046     } else {
1047       $price_src = $price_source->best_price
1048                  ? $price_source->best_price
1049                  : $price_source->price_from_source("");
1050       $price_src->price($::form->round_amount($price_src->price / $self->order->exchangerate, 5)) if $self->order->exchangerate;
1051       $price_src->price(0) if !$price_source->best_price;
1052     }
1053
1054
1055     $item->sellprice($price_src->price);
1056     $item->active_price_source($price_src);
1057
1058     $self->js
1059       ->run('kivi.Order.update_sellprice', $item_id, $item->sellprice_as_number)
1060       ->html('.row_entry:has(#item_' . $item_id . ') [name = "partnumber"] a', $item->part->partnumber)
1061       ->val ('.row_entry:has(#item_' . $item_id . ') [name = "order.orderitems[].description"]', $item->description)
1062       ->val ('.row_entry:has(#item_' . $item_id . ') [name = "order.orderitems[].longdescription"]', $item->longdescription);
1063
1064     if ($self->search_cvpartnumber) {
1065       $self->get_item_cvpartnumber($item);
1066       $self->js->html('.row_entry:has(#item_' . $item_id . ') [name = "cvpartnumber"]', $item->{cvpartnumber});
1067     }
1068   }
1069
1070   $self->recalc();
1071   $self->js_redisplay_line_values;
1072   $self->js_redisplay_amounts_and_taxes;
1073
1074   $self->js->render();
1075 }
1076
1077 sub js_load_second_row {
1078   my ($self, $item, $item_id, $do_parse) = @_;
1079
1080   if ($do_parse) {
1081     # Parse values from form (they are formated while rendering (template)).
1082     # Workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
1083     # This parsing is not necessary at all, if we assure that the second row/cvars are only loaded once.
1084     foreach my $var (@{ $item->cvars_by_config }) {
1085       $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
1086     }
1087     $item->parse_custom_variable_values;
1088   }
1089
1090   my $row_as_html = $self->p->render('order/tabs/_second_row', ITEM => $item, TYPE => $self->type);
1091
1092   $self->js
1093     ->html('#second_row_' . $item_id, $row_as_html)
1094     ->data('#second_row_' . $item_id, 'loaded', 1);
1095 }
1096
1097 sub js_redisplay_line_values {
1098   my ($self) = @_;
1099
1100   my $is_sales = $self->order->is_sales;
1101
1102   # sales orders with margins
1103   my @data;
1104   if ($is_sales) {
1105     @data = map {
1106       [
1107        $::form->format_amount(\%::myconfig, $_->{linetotal},     2, 0),
1108        $::form->format_amount(\%::myconfig, $_->{marge_total},   2, 0),
1109        $::form->format_amount(\%::myconfig, $_->{marge_percent}, 2, 0),
1110       ]} @{ $self->order->items_sorted };
1111   } else {
1112     @data = map {
1113       [
1114        $::form->format_amount(\%::myconfig, $_->{linetotal},     2, 0),
1115       ]} @{ $self->order->items_sorted };
1116   }
1117
1118   $self->js
1119     ->run('kivi.Order.redisplay_line_values', $is_sales, \@data);
1120 }
1121
1122 sub js_redisplay_amounts_and_taxes {
1123   my ($self) = @_;
1124
1125   if (scalar @{ $self->{taxes} }) {
1126     $self->js->show('#taxincluded_row_id');
1127   } else {
1128     $self->js->hide('#taxincluded_row_id');
1129   }
1130
1131   if ($self->order->taxincluded) {
1132     $self->js->hide('#subtotal_row_id');
1133   } else {
1134     $self->js->show('#subtotal_row_id');
1135   }
1136
1137   if ($self->order->is_sales) {
1138     my $is_neg = $self->order->marge_total < 0;
1139     $self->js
1140       ->html('#marge_total_id',   $::form->format_amount(\%::myconfig, $self->order->marge_total,   2))
1141       ->html('#marge_percent_id', $::form->format_amount(\%::myconfig, $self->order->marge_percent, 2))
1142       ->action_if( $is_neg, 'addClass',    '#marge_total_id',        'plus0')
1143       ->action_if( $is_neg, 'addClass',    '#marge_percent_id',      'plus0')
1144       ->action_if( $is_neg, 'addClass',    '#marge_percent_sign_id', 'plus0')
1145       ->action_if(!$is_neg, 'removeClass', '#marge_total_id',        'plus0')
1146       ->action_if(!$is_neg, 'removeClass', '#marge_percent_id',      'plus0')
1147       ->action_if(!$is_neg, 'removeClass', '#marge_percent_sign_id', 'plus0');
1148   }
1149
1150   $self->js
1151     ->html('#netamount_id', $::form->format_amount(\%::myconfig, $self->order->netamount, -2))
1152     ->html('#amount_id',    $::form->format_amount(\%::myconfig, $self->order->amount,    -2))
1153     ->remove('.tax_row')
1154     ->insertBefore($self->build_tax_rows, '#amount_row_id');
1155 }
1156
1157 sub js_redisplay_cvpartnumbers {
1158   my ($self) = @_;
1159
1160   $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
1161
1162   my @data = map {[$_->{cvpartnumber}]} @{ $self->order->items_sorted };
1163
1164   $self->js
1165     ->run('kivi.Order.redisplay_cvpartnumbers', \@data);
1166 }
1167
1168 sub js_reset_order_and_item_ids_after_save {
1169   my ($self) = @_;
1170
1171   $self->js
1172     ->val('#id', $self->order->id)
1173     ->val('#converted_from_oe_id', '')
1174     ->val('#order_' . $self->nr_key(), $self->order->number);
1175
1176   my $idx = 0;
1177   foreach my $form_item_id (@{ $::form->{orderitem_ids} }) {
1178     next if !$self->order->items_sorted->[$idx]->id;
1179     next if $form_item_id !~ m{^new};
1180     $self->js
1181       ->val ('[name="orderitem_ids[+]"][value="' . $form_item_id . '"]', $self->order->items_sorted->[$idx]->id)
1182       ->val ('#item_' . $form_item_id, $self->order->items_sorted->[$idx]->id)
1183       ->attr('#item_' . $form_item_id, "id", 'item_' . $self->order->items_sorted->[$idx]->id);
1184   } continue {
1185     $idx++;
1186   }
1187   $self->js->val('[name="converted_from_orderitems_ids[+]"]', '');
1188 }
1189
1190 #
1191 # helpers
1192 #
1193
1194 sub init_valid_types {
1195   [ sales_order_type(), purchase_order_type(), sales_quotation_type(), request_quotation_type() ];
1196 }
1197
1198 sub init_type {
1199   my ($self) = @_;
1200
1201   if (none { $::form->{type} eq $_ } @{$self->valid_types}) {
1202     die "Not a valid type for order";
1203   }
1204
1205   $self->type($::form->{type});
1206 }
1207
1208 sub init_cv {
1209   my ($self) = @_;
1210
1211   my $cv = (any { $self->type eq $_ } (sales_order_type(),    sales_quotation_type()))   ? 'customer'
1212          : (any { $self->type eq $_ } (purchase_order_type(), request_quotation_type())) ? 'vendor'
1213          : die "Not a valid type for order";
1214
1215   return $cv;
1216 }
1217
1218 sub init_search_cvpartnumber {
1219   my ($self) = @_;
1220
1221   my $user_prefs = SL::Helper::UserPreferences::PartPickerSearch->new();
1222   my $search_cvpartnumber;
1223   $search_cvpartnumber = !!$user_prefs->get_sales_search_customer_partnumber() if $self->cv eq 'customer';
1224   $search_cvpartnumber = !!$user_prefs->get_purchase_search_makemodel()        if $self->cv eq 'vendor';
1225
1226   return $search_cvpartnumber;
1227 }
1228
1229 sub init_show_update_button {
1230   my ($self) = @_;
1231
1232   !!SL::Helper::UserPreferences::UpdatePositions->new()->get_show_update_button();
1233 }
1234
1235 sub init_p {
1236   SL::Presenter->get;
1237 }
1238
1239 sub init_order {
1240   $_[0]->make_order;
1241 }
1242
1243 # model used to filter/display the parts in the multi-items dialog
1244 sub init_multi_items_models {
1245   SL::Controller::Helper::GetModels->new(
1246     controller     => $_[0],
1247     model          => 'Part',
1248     with_objects   => [ qw(unit_obj) ],
1249     disable_plugin => 'paginated',
1250     source         => $::form->{multi_items},
1251     sorted         => {
1252       _default    => {
1253         by  => 'partnumber',
1254         dir => 1,
1255       },
1256       partnumber  => t8('Partnumber'),
1257       description => t8('Description')}
1258   );
1259 }
1260
1261 sub init_all_price_factors {
1262   SL::DB::Manager::PriceFactor->get_all;
1263 }
1264
1265 sub check_auth {
1266   my ($self) = @_;
1267
1268   my $right_for = { map { $_ => $_.'_edit' } @{$self->valid_types} };
1269
1270   my $right   = $right_for->{ $self->type };
1271   $right    ||= 'DOES_NOT_EXIST';
1272
1273   $::auth->assert($right);
1274 }
1275
1276 # build the selection box for contacts
1277 #
1278 # Needed, if customer/vendor changed.
1279 sub build_contact_select {
1280   my ($self) = @_;
1281
1282   select_tag('order.cp_id', [ $self->order->{$self->cv}->contacts ],
1283     value_key  => 'cp_id',
1284     title_key  => 'full_name_dep',
1285     default    => $self->order->cp_id,
1286     with_empty => 1,
1287     style      => 'width: 300px',
1288   );
1289 }
1290
1291 # build the selection box for shiptos
1292 #
1293 # Needed, if customer/vendor changed.
1294 sub build_shipto_select {
1295   my ($self) = @_;
1296
1297   select_tag('order.shipto_id',
1298              [ {displayable_id => t8("No/individual shipping address"), shipto_id => ''}, $self->order->{$self->cv}->shipto ],
1299              value_key  => 'shipto_id',
1300              title_key  => 'displayable_id',
1301              default    => $self->order->shipto_id,
1302              with_empty => 0,
1303              style      => 'width: 300px',
1304   );
1305 }
1306
1307 # build the inputs for the cusom shipto dialog
1308 #
1309 # Needed, if customer/vendor changed.
1310 sub build_shipto_inputs {
1311   my ($self) = @_;
1312
1313   my $content = $self->p->render('common/_ship_to_dialog',
1314                                  vc_obj      => $self->order->customervendor,
1315                                  cs_obj      => $self->order->custom_shipto,
1316                                  cvars       => $self->order->custom_shipto->cvars_by_config,
1317                                  id_selector => '#order_shipto_id');
1318
1319   div_tag($content, id => 'shipto_inputs');
1320 }
1321
1322 # render the info line for business
1323 #
1324 # Needed, if customer/vendor changed.
1325 sub build_business_info_row
1326 {
1327   $_[0]->p->render('order/tabs/_business_info_row', SELF => $_[0]);
1328 }
1329
1330 # build the rows for displaying taxes
1331 #
1332 # Called if amounts where recalculated and redisplayed.
1333 sub build_tax_rows {
1334   my ($self) = @_;
1335
1336   my $rows_as_html;
1337   foreach my $tax (sort { $a->{tax}->rate cmp $b->{tax}->rate } @{ $self->{taxes} }) {
1338     $rows_as_html .= $self->p->render('order/tabs/_tax_row', TAX => $tax, TAXINCLUDED => $self->order->taxincluded);
1339   }
1340   return $rows_as_html;
1341 }
1342
1343
1344 sub render_price_dialog {
1345   my ($self, $record_item) = @_;
1346
1347   my $price_source = SL::PriceSource->new(record_item => $record_item, record => $self->order);
1348
1349   $self->js
1350     ->run(
1351       'kivi.io.price_chooser_dialog',
1352       t8('Available Prices'),
1353       $self->render('order/tabs/_price_sources_dialog', { output => 0 }, price_source => $price_source)
1354     )
1355     ->reinit_widgets;
1356
1357 #   if (@errors) {
1358 #     $self->js->text('#dialog_flash_error_content', join ' ', @errors);
1359 #     $self->js->show('#dialog_flash_error');
1360 #   }
1361
1362   $self->js->render;
1363 }
1364
1365 sub load_order {
1366   my ($self) = @_;
1367
1368   return if !$::form->{id};
1369
1370   $self->order(SL::DB::Order->new(id => $::form->{id})->load);
1371
1372   # Add an empty custom shipto to the order, so that the dialog can render the cvar inputs.
1373   # You need a custom shipto object to call cvars_by_config to get the cvars.
1374   $self->order->custom_shipto(SL::DB::Shipto->new(module => 'OE', custom_variables => [])) if !$self->order->custom_shipto;
1375
1376   return $self->order;
1377 }
1378
1379 # load or create a new order object
1380 #
1381 # And assign changes from the form to this object.
1382 # If the order is loaded from db, check if items are deleted in the form,
1383 # remove them form the object and collect them for removing from db on saving.
1384 # Then create/update items from form (via make_item) and add them.
1385 sub make_order {
1386   my ($self) = @_;
1387
1388   # add_items adds items to an order with no items for saving, but they cannot
1389   # be retrieved via items until the order is saved. Adding empty items to new
1390   # order here solves this problem.
1391   my $order;
1392   $order   = SL::DB::Order->new(id => $::form->{id})->load(with => [ 'orderitems', 'orderitems.part' ]) if $::form->{id};
1393   $order ||= SL::DB::Order->new(orderitems  => [],
1394                                 quotation   => (any { $self->type eq $_ } (sales_quotation_type(), request_quotation_type())),
1395                                 currency_id => $::instance_conf->get_currency_id(),);
1396
1397   my $cv_id_method = $self->cv . '_id';
1398   if (!$::form->{id} && $::form->{$cv_id_method}) {
1399     $order->$cv_id_method($::form->{$cv_id_method});
1400     setup_order_from_cv($order);
1401   }
1402
1403   my $form_orderitems                  = delete $::form->{order}->{orderitems};
1404   my $form_periodic_invoices_config    = delete $::form->{order}->{periodic_invoices_config};
1405
1406   $order->assign_attributes(%{$::form->{order}});
1407
1408   $self->setup_custom_shipto_from_form($order, $::form);
1409
1410   if (my $periodic_invoices_config_attrs = $form_periodic_invoices_config ? SL::YAML::Load($form_periodic_invoices_config) : undef) {
1411     my $periodic_invoices_config = $order->periodic_invoices_config || $order->periodic_invoices_config(SL::DB::PeriodicInvoicesConfig->new);
1412     $periodic_invoices_config->assign_attributes(%$periodic_invoices_config_attrs);
1413   }
1414
1415   # remove deleted items
1416   $self->item_ids_to_delete([]);
1417   foreach my $idx (reverse 0..$#{$order->orderitems}) {
1418     my $item = $order->orderitems->[$idx];
1419     if (none { $item->id == $_->{id} } @{$form_orderitems}) {
1420       splice @{$order->orderitems}, $idx, 1;
1421       push @{$self->item_ids_to_delete}, $item->id;
1422     }
1423   }
1424
1425   my @items;
1426   my $pos = 1;
1427   foreach my $form_attr (@{$form_orderitems}) {
1428     my $item = make_item($order, $form_attr);
1429     $item->position($pos);
1430     push @items, $item;
1431     $pos++;
1432   }
1433   $order->add_items(grep {!$_->id} @items);
1434
1435   return $order;
1436 }
1437
1438 # create or update items from form
1439 #
1440 # Make item objects from form values. For items already existing read from db.
1441 # Create a new item else. And assign attributes.
1442 sub make_item {
1443   my ($record, $attr) = @_;
1444
1445   my $item;
1446   $item = first { $_->id == $attr->{id} } @{$record->items} if $attr->{id};
1447
1448   my $is_new = !$item;
1449
1450   # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
1451   # they cannot be retrieved via custom_variables until the order/orderitem is
1452   # saved. Adding empty custom_variables to new orderitem here solves this problem.
1453   $item ||= SL::DB::OrderItem->new(custom_variables => []);
1454
1455   $item->assign_attributes(%$attr);
1456   $item->longdescription($item->part->notes)                     if $is_new && !defined $attr->{longdescription};
1457   $item->project_id($record->globalproject_id)                   if $is_new && !defined $attr->{project_id};
1458   $item->lastcost($record->is_sales ? $item->part->lastcost : 0) if $is_new && !defined $attr->{lastcost_as_number};
1459
1460   return $item;
1461 }
1462
1463 # create a new item
1464 #
1465 # This is used to add one item
1466 sub new_item {
1467   my ($record, $attr) = @_;
1468
1469   my $item = SL::DB::OrderItem->new;
1470
1471   # Remove attributes where the user left or set the inputs empty.
1472   # So these attributes will be undefined and we can distinguish them
1473   # from zero later on.
1474   for (qw(qty_as_number sellprice_as_number discount_as_percent)) {
1475     delete $attr->{$_} if $attr->{$_} eq '';
1476   }
1477
1478   $item->assign_attributes(%$attr);
1479
1480   my $part         = SL::DB::Part->new(id => $attr->{parts_id})->load;
1481   my $price_source = SL::PriceSource->new(record_item => $item, record => $record);
1482
1483   $item->unit($part->unit) if !$item->unit;
1484
1485   my $price_src;
1486   if ( $part->is_assortment ) {
1487     # add assortment items with price 0, as the components carry the price
1488     $price_src = $price_source->price_from_source("");
1489     $price_src->price(0);
1490   } elsif (defined $item->sellprice) {
1491     $price_src = $price_source->price_from_source("");
1492     $price_src->price($item->sellprice);
1493   } else {
1494     $price_src = $price_source->best_price
1495                ? $price_source->best_price
1496                : $price_source->price_from_source("");
1497     $price_src->price($::form->round_amount($price_src->price / $record->exchangerate, 5)) if $record->exchangerate;
1498     $price_src->price(0) if !$price_source->best_price;
1499   }
1500
1501   my $discount_src;
1502   if (defined $item->discount) {
1503     $discount_src = $price_source->discount_from_source("");
1504     $discount_src->discount($item->discount);
1505   } else {
1506     $discount_src = $price_source->best_discount
1507                   ? $price_source->best_discount
1508                   : $price_source->discount_from_source("");
1509     $discount_src->discount(0) if !$price_source->best_discount;
1510   }
1511
1512   my %new_attr;
1513   $new_attr{part}                   = $part;
1514   $new_attr{description}            = $part->description     if ! $item->description;
1515   $new_attr{qty}                    = 1.0                    if ! $item->qty;
1516   $new_attr{price_factor_id}        = $part->price_factor_id if ! $item->price_factor_id;
1517   $new_attr{sellprice}              = $price_src->price;
1518   $new_attr{discount}               = $discount_src->discount;
1519   $new_attr{active_price_source}    = $price_src;
1520   $new_attr{active_discount_source} = $discount_src;
1521   $new_attr{longdescription}        = $part->notes           if ! defined $attr->{longdescription};
1522   $new_attr{project_id}             = $record->globalproject_id;
1523   $new_attr{lastcost}               = $record->is_sales ? $part->lastcost : 0;
1524
1525   # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
1526   # they cannot be retrieved via custom_variables until the order/orderitem is
1527   # saved. Adding empty custom_variables to new orderitem here solves this problem.
1528   $new_attr{custom_variables} = [];
1529
1530   $item->assign_attributes(%new_attr);
1531
1532   return $item;
1533 }
1534
1535 sub setup_order_from_cv {
1536   my ($order) = @_;
1537
1538   $order->$_($order->customervendor->$_) for (qw(taxzone_id payment_id delivery_term_id currency_id));
1539
1540   $order->intnotes($order->customervendor->notes);
1541
1542   if ($order->is_sales) {
1543     $order->salesman_id($order->customer->salesman_id || SL::DB::Manager::Employee->current->id);
1544     $order->taxincluded(defined($order->customer->taxincluded_checked)
1545                         ? $order->customer->taxincluded_checked
1546                         : $::myconfig{taxincluded_checked});
1547   }
1548
1549 }
1550
1551 # setup custom shipto from form
1552 #
1553 # The dialog returns form variables starting with 'shipto' and cvars starting
1554 # with 'shiptocvar_'.
1555 # Mark it to be deleted if a shipto from master data is selected
1556 # (i.e. order has a shipto).
1557 # Else, update or create a new custom shipto. If the fields are empty, it
1558 # will not be saved on save.
1559 sub setup_custom_shipto_from_form {
1560   my ($self, $order, $form) = @_;
1561
1562   if ($order->shipto) {
1563     $self->is_custom_shipto_to_delete(1);
1564   } else {
1565     my $custom_shipto = $order->custom_shipto || $order->custom_shipto(SL::DB::Shipto->new(module => 'OE', custom_variables => []));
1566
1567     my $shipto_cvars  = {map { my ($key) = m{^shiptocvar_(.+)}; $key => delete $form->{$_}} grep { m{^shiptocvar_} } keys %$form};
1568     my $shipto_attrs  = {map {                                  $_   => delete $form->{$_}} grep { m{^shipto}      } keys %$form};
1569
1570     $custom_shipto->assign_attributes(%$shipto_attrs);
1571     $custom_shipto->cvar_by_name($_)->value($shipto_cvars->{$_}) for keys %$shipto_cvars;
1572   }
1573 }
1574
1575 # recalculate prices and taxes
1576 #
1577 # Using the PriceTaxCalculator. Store linetotals in the item objects.
1578 sub recalc {
1579   my ($self) = @_;
1580
1581   my %pat = $self->order->calculate_prices_and_taxes();
1582
1583   $self->{taxes} = [];
1584   foreach my $tax_id (keys %{ $pat{taxes_by_tax_id} }) {
1585     my $netamount = sum0 map { $pat{amounts}->{$_}->{amount} } grep { $pat{amounts}->{$_}->{tax_id} == $tax_id } keys %{ $pat{amounts} };
1586
1587     push(@{ $self->{taxes} }, { amount    => $pat{taxes_by_tax_id}->{$tax_id},
1588                                 netamount => $netamount,
1589                                 tax       => SL::DB::Tax->new(id => $tax_id)->load });
1590   }
1591   pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items_sorted}, @{$pat{items}};
1592 }
1593
1594 # get data for saving, printing, ..., that is not changed in the form
1595 #
1596 # Only cvars for now.
1597 sub get_unalterable_data {
1598   my ($self) = @_;
1599
1600   foreach my $item (@{ $self->order->items }) {
1601     # autovivify all cvars that are not in the form (cvars_by_config can do it).
1602     # workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
1603     foreach my $var (@{ $item->cvars_by_config }) {
1604       $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
1605     }
1606     $item->parse_custom_variable_values;
1607   }
1608 }
1609
1610 # delete the order
1611 #
1612 # And remove related files in the spool directory
1613 sub delete {
1614   my ($self) = @_;
1615
1616   my $errors = [];
1617   my $db     = $self->order->db;
1618
1619   $db->with_transaction(
1620     sub {
1621       my @spoolfiles = grep { $_ } map { $_->spoolfile } @{ SL::DB::Manager::Status->get_all(where => [ trans_id => $self->order->id ]) };
1622       $self->order->delete;
1623       my $spool = $::lx_office_conf{paths}->{spool};
1624       unlink map { "$spool/$_" } @spoolfiles if $spool;
1625
1626       1;
1627   }) || push(@{$errors}, $db->error);
1628
1629   return $errors;
1630 }
1631
1632 # save the order
1633 #
1634 # And delete items that are deleted in the form.
1635 sub save {
1636   my ($self) = @_;
1637
1638   my $errors = [];
1639   my $db     = $self->order->db;
1640
1641   $db->with_transaction(sub {
1642     # delete custom shipto if it is to be deleted or if it is empty
1643     if ($self->order->custom_shipto && ($self->is_custom_shipto_to_delete || $self->order->custom_shipto->is_empty)) {
1644       $self->order->custom_shipto->delete if $self->order->custom_shipto->shipto_id;
1645       $self->order->custom_shipto(undef);
1646     }
1647
1648     SL::DB::OrderItem->new(id => $_)->delete for @{$self->item_ids_to_delete || []};
1649     $self->order->save(cascade => 1);
1650
1651     # link records
1652     if ($::form->{converted_from_oe_id}) {
1653       my @converted_from_oe_ids = split ' ', $::form->{converted_from_oe_id};
1654       foreach my $converted_from_oe_id (@converted_from_oe_ids) {
1655         my $src = SL::DB::Order->new(id => $converted_from_oe_id)->load;
1656         $src->update_attributes(closed => 1) if $src->type =~ /_quotation$/;
1657         $src->link_to_record($self->order);
1658       }
1659       if (scalar @{ $::form->{converted_from_orderitems_ids} || [] }) {
1660         my $idx = 0;
1661         foreach (@{ $self->order->items_sorted }) {
1662           my $from_id = $::form->{converted_from_orderitems_ids}->[$idx];
1663           next if !$from_id;
1664           SL::DB::RecordLink->new(from_table => 'orderitems',
1665                                   from_id    => $from_id,
1666                                   to_table   => 'orderitems',
1667                                   to_id      => $_->id
1668           )->save;
1669           $idx++;
1670         }
1671       }
1672     }
1673     1;
1674   }) || push(@{$errors}, $db->error);
1675
1676   return $errors;
1677 }
1678
1679 sub workflow_sales_or_purchase_order {
1680   my ($self) = @_;
1681
1682   # always save
1683   my $errors = $self->save();
1684
1685   if (scalar @{ $errors }) {
1686     $self->js->flash('error', $_) foreach @{ $errors };
1687     return $self->js->render();
1688   }
1689
1690   my $destination_type = $::form->{type} eq sales_quotation_type()   ? sales_order_type()
1691                        : $::form->{type} eq request_quotation_type() ? purchase_order_type()
1692                        : $::form->{type} eq purchase_order_type()    ? sales_order_type()
1693                        : $::form->{type} eq sales_order_type()       ? purchase_order_type()
1694                        : '';
1695
1696   # check for direct delivery
1697   # copy shipto in custom shipto (custom shipto will be copied by new_from() in case)
1698   my $custom_shipto;
1699   if (   $::form->{type} eq sales_order_type() && $destination_type eq purchase_order_type()
1700       && $::form->{use_shipto} && $self->order->shipto) {
1701     $custom_shipto = $self->order->shipto->clone('SL::DB::Order');
1702   }
1703
1704   $self->order(SL::DB::Order->new_from($self->order, destination_type => $destination_type));
1705   $self->{converted_from_oe_id} = delete $::form->{id};
1706
1707   # set item ids to new fake id, to identify them as new items
1708   foreach my $item (@{$self->order->items_sorted}) {
1709     $item->{new_fake_id} = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
1710   }
1711
1712   if ($::form->{type} eq sales_order_type() && $destination_type eq purchase_order_type()) {
1713     if ($::form->{use_shipto}) {
1714       $self->order->custom_shipto($custom_shipto) if $custom_shipto;
1715     } else {
1716       # remove any custom shipto if not wanted
1717       $self->order->custom_shipto(SL::DB::Shipto->new(module => 'OE', custom_variables => []));
1718     }
1719   }
1720
1721   # change form type
1722   $::form->{type} = $destination_type;
1723   $self->type($self->init_type);
1724   $self->cv  ($self->init_cv);
1725   $self->check_auth;
1726
1727   $self->recalc();
1728   $self->get_unalterable_data();
1729   $self->pre_render();
1730
1731   # trigger rendering values for second row/longdescription as hidden,
1732   # because they are loaded only on demand. So we need to keep the values
1733   # from the source.
1734   $_->{render_second_row}      = 1 for @{ $self->order->items_sorted };
1735   $_->{render_longdescription} = 1 for @{ $self->order->items_sorted };
1736
1737   $self->render(
1738     'order/form',
1739     title => $self->get_title_for('edit'),
1740     %{$self->{template_args}}
1741   );
1742 }
1743
1744
1745 sub pre_render {
1746   my ($self) = @_;
1747
1748   $self->{all_taxzones}               = SL::DB::Manager::TaxZone->get_all_sorted();
1749   $self->{all_currencies}             = SL::DB::Manager::Currency->get_all_sorted();
1750   $self->{all_departments}            = SL::DB::Manager::Department->get_all_sorted();
1751   $self->{all_employees}              = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->employee_id,
1752                                                                                               deleted => 0 ] ],
1753                                                                            sort_by => 'name');
1754   $self->{all_salesmen}               = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->salesman_id,
1755                                                                                               deleted => 0 ] ],
1756                                                                            sort_by => 'name');
1757   $self->{all_payment_terms}          = SL::DB::Manager::PaymentTerm->get_all_sorted(where => [ or => [ id => $self->order->payment_id,
1758                                                                                                         obsolete => 0 ] ]);
1759   $self->{all_delivery_terms}         = SL::DB::Manager::DeliveryTerm->get_all_sorted();
1760   $self->{current_employee_id}        = SL::DB::Manager::Employee->current->id;
1761   $self->{periodic_invoices_status}   = $self->get_periodic_invoices_status($self->order->periodic_invoices_config);
1762   $self->{order_probabilities}        = [ map { { title => ($_ * 10) . '%', id => $_ * 10 } } (0..10) ];
1763   $self->{positions_scrollbar_height} = SL::Helper::UserPreferences::PositionsScrollbar->new()->get_height();
1764
1765   my $print_form = Form->new('');
1766   $print_form->{type}        = $self->type;
1767   $print_form->{printers}    = SL::DB::Manager::Printer->get_all_sorted;
1768   $print_form->{languages}   = SL::DB::Manager::Language->get_all_sorted;
1769   $print_form->{language_id} = $self->order->language_id;
1770   $self->{print_options}     = SL::Helper::PrintOptions->get_print_options(
1771     form => $print_form,
1772     options => {dialog_name_prefix => 'print_options.',
1773                 show_headers       => 1,
1774                 no_queue           => 1,
1775                 no_postscript      => 1,
1776                 no_opendocument    => 0,
1777                 no_html            => 1},
1778   );
1779
1780   foreach my $item (@{$self->order->orderitems}) {
1781     my $price_source = SL::PriceSource->new(record_item => $item, record => $self->order);
1782     $item->active_price_source(   $price_source->price_from_source(   $item->active_price_source   ));
1783     $item->active_discount_source($price_source->discount_from_source($item->active_discount_source));
1784   }
1785
1786   if (any { $self->type eq $_ } (sales_order_type(), purchase_order_type())) {
1787     # calculate shipped qtys here to prevent calling calculate for every item via the items method
1788     SL::Helper::ShippedQty->new->calculate($self->order)->write_to_objects;
1789   }
1790
1791   if ($self->order->number && $::instance_conf->get_webdav) {
1792     my $webdav = SL::Webdav->new(
1793       type     => $self->type,
1794       number   => $self->order->number,
1795     );
1796     my @all_objects = $webdav->get_all_objects;
1797     @{ $self->{template_args}->{WEBDAV} } = map { { name => $_->filename,
1798                                                     type => t8('File'),
1799                                                     link => File::Spec->catfile($_->full_filedescriptor),
1800                                                 } } @all_objects;
1801   }
1802
1803   $self->get_item_cvpartnumber($_) for @{$self->order->items_sorted};
1804
1805   $::request->{layout}->use_javascript("${_}.js") for qw(kivi.SalesPurchase kivi.Order kivi.File ckeditor/ckeditor ckeditor/adapters/jquery
1806                                                          edit_periodic_invoices_config calculate_qty kivi.Validator);
1807   $self->setup_edit_action_bar;
1808 }
1809
1810 sub setup_edit_action_bar {
1811   my ($self, %params) = @_;
1812
1813   my $deletion_allowed = (any { $self->type eq $_ } (sales_quotation_type(), request_quotation_type()))
1814                       || (($self->type eq sales_order_type())    && $::instance_conf->get_sales_order_show_delete)
1815                       || (($self->type eq purchase_order_type()) && $::instance_conf->get_purchase_order_show_delete);
1816
1817   for my $bar ($::request->layout->get('actionbar')) {
1818     $bar->add(
1819       combobox => [
1820         action => [
1821           t8('Save'),
1822           call      => [ 'kivi.Order.save', 'save', $::instance_conf->get_order_warn_duplicate_parts,
1823                                                     $::instance_conf->get_order_warn_no_deliverydate,
1824                                                                                                       ],
1825           checks    => [ 'kivi.Order.check_save_active_periodic_invoices', ['kivi.validate_form','#order_form'] ],
1826         ],
1827         action => [
1828           t8('Save as new'),
1829           call      => [ 'kivi.Order.save', 'save_as_new', $::instance_conf->get_order_warn_duplicate_parts ],
1830           checks    => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1831           disabled  => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1832         ],
1833       ], # end of combobox "Save"
1834
1835       combobox => [
1836         action => [
1837           t8('Workflow'),
1838         ],
1839         action => [
1840           t8('Save and Sales Order'),
1841           submit   => [ '#order_form', { action => "Order/sales_order" } ],
1842           only_if  => (any { $self->type eq $_ } (sales_quotation_type(), purchase_order_type())),
1843         ],
1844         action => [
1845           t8('Save and Purchase Order'),
1846           call      => [ 'kivi.Order.purchase_order_check_for_direct_delivery' ],
1847           only_if   => (any { $self->type eq $_ } (sales_order_type(), request_quotation_type())),
1848         ],
1849         action => [
1850           t8('Save and Delivery Order'),
1851           call      => [ 'kivi.Order.save', 'save_and_delivery_order', $::instance_conf->get_order_warn_duplicate_parts,
1852                                                                        $::instance_conf->get_order_warn_no_deliverydate,
1853                                                                                                                         ],
1854           checks    => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1855           only_if   => (any { $self->type eq $_ } (sales_order_type(), purchase_order_type()))
1856         ],
1857         action => [
1858           t8('Save and Invoice'),
1859           call      => [ 'kivi.Order.save', 'save_and_invoice', $::instance_conf->get_order_warn_duplicate_parts ],
1860           checks    => [ 'kivi.Order.check_save_active_periodic_invoices' ],
1861         ],
1862         action => [
1863           t8('Save and AP Transaction'),
1864           call      => [ 'kivi.Order.save', 'save_and_ap_transaction', $::instance_conf->get_order_warn_duplicate_parts ],
1865           only_if   => (any { $self->type eq $_ } (purchase_order_type()))
1866         ],
1867
1868       ], # end of combobox "Workflow"
1869
1870       combobox => [
1871         action => [
1872           t8('Export'),
1873         ],
1874         action => [
1875           t8('Save and print'),
1876           call => [ 'kivi.Order.show_print_options', $::instance_conf->get_order_warn_duplicate_parts ],
1877         ],
1878         action => [
1879           t8('Save and E-mail'),
1880           call => [ 'kivi.Order.email', $::instance_conf->get_order_warn_duplicate_parts ],
1881         ],
1882         action => [
1883           t8('Download attachments of all parts'),
1884           call     => [ 'kivi.File.downloadOrderitemsFiles', $::form->{type}, $::form->{id} ],
1885           disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1886           only_if  => $::instance_conf->get_doc_storage,
1887         ],
1888       ], # end of combobox "Export"
1889
1890       action => [
1891         t8('Delete'),
1892         call     => [ 'kivi.Order.delete_order' ],
1893         confirm  => $::locale->text('Do you really want to delete this object?'),
1894         disabled => !$self->order->id ? t8('This object has not been saved yet.') : undef,
1895         only_if  => $deletion_allowed,
1896       ],
1897     );
1898   }
1899 }
1900
1901 sub generate_pdf {
1902   my ($order, $pdf_ref, $params) = @_;
1903
1904   my @errors = ();
1905
1906   my $print_form = Form->new('');
1907   $print_form->{type}        = $order->type;
1908   $print_form->{formname}    = $params->{formname} || $order->type;
1909   $print_form->{format}      = $params->{format}   || 'pdf';
1910   $print_form->{media}       = $params->{media}    || 'file';
1911   $print_form->{groupitems}  = $params->{groupitems};
1912   $print_form->{media}       = 'file'                             if $print_form->{media} eq 'screen';
1913
1914   $order->language($params->{language});
1915   $order->flatten_to_form($print_form, format_amounts => 1);
1916
1917   my $template_ext;
1918   my $template_type;
1919   if ($print_form->{format} =~ /(opendocument|oasis)/i) {
1920     $template_ext  = 'odt';
1921     $template_type = 'OpenDocument';
1922   }
1923
1924   # search for the template
1925   my ($template_file, @template_files) = SL::Helper::CreatePDF->find_template(
1926     name        => $print_form->{formname},
1927     extension   => $template_ext,
1928     email       => $print_form->{media} eq 'email',
1929     language    => $params->{language},
1930     printer_id  => $print_form->{printer_id},  # todo
1931   );
1932
1933   if (!defined $template_file) {
1934     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);
1935   }
1936
1937   return @errors if scalar @errors;
1938
1939   $print_form->throw_on_error(sub {
1940     eval {
1941       $print_form->prepare_for_printing;
1942
1943       $$pdf_ref = SL::Helper::CreatePDF->create_pdf(
1944         format        => $print_form->{format},
1945         template_type => $template_type,
1946         template      => $template_file,
1947         variables     => $print_form,
1948         variable_content_types => {
1949           longdescription => 'html',
1950           partnotes       => 'html',
1951           notes           => 'html',
1952         },
1953       );
1954       1;
1955     } || push @errors, ref($EVAL_ERROR) eq 'SL::X::FormError' ? $EVAL_ERROR->error : $EVAL_ERROR;
1956   });
1957
1958   return @errors;
1959 }
1960
1961 sub get_files_for_email_dialog {
1962   my ($self) = @_;
1963
1964   my %files = map { ($_ => []) } qw(versions files vc_files part_files);
1965
1966   return %files if !$::instance_conf->get_doc_storage;
1967
1968   if ($self->order->id) {
1969     $files{versions} = [ SL::File->get_all_versions(object_id => $self->order->id,              object_type => $self->order->type, file_type => 'document') ];
1970     $files{files}    = [ SL::File->get_all(         object_id => $self->order->id,              object_type => $self->order->type, file_type => 'attachment') ];
1971     $files{vc_files} = [ SL::File->get_all(         object_id => $self->order->{$self->cv}->id, object_type => $self->cv,          file_type => 'attachment') ];
1972   }
1973
1974   my @parts =
1975     uniq_by { $_->{id} }
1976     map {
1977       +{ id         => $_->part->id,
1978          partnumber => $_->part->partnumber }
1979     } @{$self->order->items_sorted};
1980
1981   foreach my $part (@parts) {
1982     my @pfiles = SL::File->get_all(object_id => $part->{id}, object_type => 'part');
1983     push @{ $files{part_files} }, map { +{ %{ $_ }, partnumber => $part->{partnumber} } } @pfiles;
1984   }
1985
1986   foreach my $key (keys %files) {
1987     $files{$key} = [ sort_by { lc $_->{db_file}->{file_name} } @{ $files{$key} } ];
1988   }
1989
1990   return %files;
1991 }
1992
1993 sub make_periodic_invoices_config_from_yaml {
1994   my ($yaml_config) = @_;
1995
1996   return if !$yaml_config;
1997   my $attr = SL::YAML::Load($yaml_config);
1998   return if 'HASH' ne ref $attr;
1999   return SL::DB::PeriodicInvoicesConfig->new(%$attr);
2000 }
2001
2002
2003 sub get_periodic_invoices_status {
2004   my ($self, $config) = @_;
2005
2006   return                      if $self->type ne sales_order_type();
2007   return t8('not configured') if !$config;
2008
2009   my $active = ('HASH' eq ref $config)                           ? $config->{active}
2010              : ('SL::DB::PeriodicInvoicesConfig' eq ref $config) ? $config->active
2011              :                                                     die "Cannot get status of periodic invoices config";
2012
2013   return $active ? t8('active') : t8('inactive');
2014 }
2015
2016 sub get_title_for {
2017   my ($self, $action) = @_;
2018
2019   return '' if none { lc($action)} qw(add edit);
2020
2021   # for locales:
2022   # $::locale->text("Add Sales Order");
2023   # $::locale->text("Add Purchase Order");
2024   # $::locale->text("Add Quotation");
2025   # $::locale->text("Add Request for Quotation");
2026   # $::locale->text("Edit Sales Order");
2027   # $::locale->text("Edit Purchase Order");
2028   # $::locale->text("Edit Quotation");
2029   # $::locale->text("Edit Request for Quotation");
2030
2031   $action = ucfirst(lc($action));
2032   return $self->type eq sales_order_type()       ? $::locale->text("$action Sales Order")
2033        : $self->type eq purchase_order_type()    ? $::locale->text("$action Purchase Order")
2034        : $self->type eq sales_quotation_type()   ? $::locale->text("$action Quotation")
2035        : $self->type eq request_quotation_type() ? $::locale->text("$action Request for Quotation")
2036        : '';
2037 }
2038
2039 sub get_item_cvpartnumber {
2040   my ($self, $item) = @_;
2041
2042   return if !$self->search_cvpartnumber;
2043   return if !$self->order->customervendor;
2044
2045   if ($self->cv eq 'vendor') {
2046     my @mms = grep { $_->make eq $self->order->customervendor->id } @{$item->part->makemodels};
2047     $item->{cvpartnumber} = $mms[0]->model if scalar @mms;
2048   } elsif ($self->cv eq 'customer') {
2049     my @cps = grep { $_->customer_id eq $self->order->customervendor->id } @{$item->part->customerprices};
2050     $item->{cvpartnumber} = $cps[0]->customer_partnumber if scalar @cps;
2051   }
2052 }
2053
2054 sub sales_order_type {
2055   'sales_order';
2056 }
2057
2058 sub purchase_order_type {
2059   'purchase_order';
2060 }
2061
2062 sub sales_quotation_type {
2063   'sales_quotation';
2064 }
2065
2066 sub request_quotation_type {
2067   'request_quotation';
2068 }
2069
2070 sub nr_key {
2071   return $_[0]->type eq sales_order_type()       ? 'ordnumber'
2072        : $_[0]->type eq purchase_order_type()    ? 'ordnumber'
2073        : $_[0]->type eq sales_quotation_type()   ? 'quonumber'
2074        : $_[0]->type eq request_quotation_type() ? 'quonumber'
2075        : '';
2076 }
2077
2078 1;
2079
2080 __END__
2081
2082 =encoding utf-8
2083
2084 =head1 NAME
2085
2086 SL::Controller::Order - controller for orders
2087
2088 =head1 SYNOPSIS
2089
2090 This is a new form to enter orders, completely rewritten with the use
2091 of controller and java script techniques.
2092
2093 The aim is to provide the user a better experience and a faster workflow. Also
2094 the code should be more readable, more reliable and better to maintain.
2095
2096 =head2 Key Features
2097
2098 =over 4
2099
2100 =item *
2101
2102 One input row, so that input happens every time at the same place.
2103
2104 =item *
2105
2106 Use of pickers where possible.
2107
2108 =item *
2109
2110 Possibility to enter more than one item at once.
2111
2112 =item *
2113
2114 Item list in a scrollable area, so that the workflow buttons stay at
2115 the bottom.
2116
2117 =item *
2118
2119 Reordering item rows with drag and drop is possible. Sorting item rows is
2120 possible (by partnumber, description, qty, sellprice and discount for now).
2121
2122 =item *
2123
2124 No C<update> is necessary. All entries and calculations are managed
2125 with ajax-calls and the page only reloads on C<save>.
2126
2127 =item *
2128
2129 User can see changes immediately, because of the use of java script
2130 and ajax.
2131
2132 =back
2133
2134 =head1 CODE
2135
2136 =head2 Layout
2137
2138 =over 4
2139
2140 =item * C<SL/Controller/Order.pm>
2141
2142 the controller
2143
2144 =item * C<template/webpages/order/form.html>
2145
2146 main form
2147
2148 =item * C<template/webpages/order/tabs/basic_data.html>
2149
2150 Main tab for basic_data.
2151
2152 This is the only tab here for now. "linked records" and "webdav" tabs are
2153 reused from generic code.
2154
2155 =over 4
2156
2157 =item * C<template/webpages/order/tabs/_business_info_row.html>
2158
2159 For displaying information on business type
2160
2161 =item * C<template/webpages/order/tabs/_item_input.html>
2162
2163 The input line for items
2164
2165 =item * C<template/webpages/order/tabs/_row.html>
2166
2167 One row for already entered items
2168
2169 =item * C<template/webpages/order/tabs/_tax_row.html>
2170
2171 Displaying tax information
2172
2173 =item * C<template/webpages/order/tabs/_multi_items_dialog.html>
2174
2175 Dialog for entering more than one item at once
2176
2177 =item * C<template/webpages/order/tabs/_multi_items_result.html>
2178
2179 Results for the filter in the multi items dialog
2180
2181 =item * C<template/webpages/order/tabs/_price_sources_dialog.html>
2182
2183 Dialog for selecting price and discount sources
2184
2185 =back
2186
2187 =item * C<js/kivi.Order.js>
2188
2189 java script functions
2190
2191 =back
2192
2193 =head1 TODO
2194
2195 =over 4
2196
2197 =item * testing
2198
2199 =item * credit limit
2200
2201 =item * more workflows (quotation, rfq)
2202
2203 =item * price sources: little symbols showing better price / better discount
2204
2205 =item * select units in input row?
2206
2207 =item * check for direct delivery (workflow sales order -> purchase order)
2208
2209 =item * language / part translations
2210
2211 =item * access rights
2212
2213 =item * display weights
2214
2215 =item * history
2216
2217 =item * mtime check
2218
2219 =item * optional client/user behaviour
2220
2221 (transactions has to be set - department has to be set -
2222  force project if enabled in client config - transport cost reminder)
2223
2224 =back
2225
2226 =head1 KNOWN BUGS AND CAVEATS
2227
2228 =over 4
2229
2230 =item *
2231
2232 Customer discount is not displayed as a valid discount in price source popup
2233 (this might be a bug in price sources)
2234
2235 (I cannot reproduce this (Bernd))
2236
2237 =item *
2238
2239 No indication that <shift>-up/down expands/collapses second row.
2240
2241 =item *
2242
2243 Inline creation of parts is not currently supported
2244
2245 =item *
2246
2247 Table header is not sticky in the scrolling area.
2248
2249 =item *
2250
2251 Sorting does not include C<position>, neither does reordering.
2252
2253 This behavior was implemented intentionally. But we can discuss, which behavior
2254 should be implemented.
2255
2256 =item *
2257
2258 C<show_multi_items_dialog> does not use the currently inserted string for
2259 filtering.
2260
2261 =back
2262
2263 =head1 To discuss / Nice to have
2264
2265 =over 4
2266
2267 =item *
2268
2269 How to expand/collapse second row. Now it can be done clicking the icon or
2270 <shift>-up/down.
2271
2272 =item *
2273
2274 Possibility to change longdescription in input row?
2275
2276 =item *
2277
2278 Possibility to select PriceSources in input row?
2279
2280 =item *
2281
2282 This controller uses a (changed) copy of the template for the PriceSource
2283 dialog. Maybe there could be used one code source.
2284
2285 =item *
2286
2287 Rounding-differences between this controller (PriceTaxCalculator) and the old
2288 form. This is not only a problem here, but also in all parts using the PTC.
2289 There exists a ticket and a patch. This patch should be testet.
2290
2291 =item *
2292
2293 An indicator, if the actual inputs are saved (like in an
2294 editor or on text processing application).
2295
2296 =item *
2297
2298 A warning when leaving the page without saveing unchanged inputs.
2299
2300
2301 =back
2302
2303 =head1 AUTHOR
2304
2305 Bernd Bleßmann E<lt>bernd@kivitendo-premium.deE<gt>
2306
2307 =cut