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