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;
   7 use SL::Presenter;
   8 use SL::Locale::String;
   9 use SL::SessionFile::Random;
  10 use SL::PriceSource;
  11 use SL::Form;
  12
  13 use SL::DB::Order;
  14 use SL::DB::Customer;
  15 use SL::DB::Vendor;
  16 use SL::DB::TaxZone;
  17 use SL::DB::Employee;
  18 use SL::DB::Project;
  19 use SL::DB::Default;
  20 use SL::DB::Unit;
  21
  22 use SL::Helper::DateTime;
  23 use SL::Helper::CreatePDF qw(:all);
  24
  25 use List::Util qw(max first);
  26 use List::MoreUtils qw(none pairwise);
  27 use English qw(-no_match_vars);
  28 use File::Spec;
  29
  30 use Rose::Object::MakeMethods::Generic
  31 (
  32  'scalar --get_set_init' => [ qw(order valid_types type cv p) ],
  33 );
  34
  35
  36 # safety
  37 __PACKAGE__->run_before('_check_auth');
  38
  39 __PACKAGE__->run_before('_recalc',
  40                         only => [ qw(edit update save save_and_delivery_order create_pdf send_email) ]);
  41
  42 __PACKAGE__->run_before('_get_unalterable_data',
  43                         only => [ qw(save save_and_delivery_order create_pdf send_email) ]);
  44
  45 #
  46 # actions
  47 #
  48
  49 sub action_add {
  50   my ($self) = @_;
  51
  52   $self->order->transdate(DateTime->now_local());
  53
  54   $self->_pre_render();
  55   $self->render(
  56     'order/form',
  57     title => $self->type eq _sales_order_type()    ? $::locale->text('Add Sales Order')
  58            : $self->type eq _purchase_order_type() ? $::locale->text('Add Purchase Order')
  59            : '',
  60     %{$self->{template_args}}
  61   );
  62 }
  63
  64 sub action_edit {
  65   my ($self) = @_;
  66
  67   $self->_pre_render();
  68   $self->render(
  69     'order/form',
  70     title => $self->type eq _sales_order_type()    ? $::locale->text('Edit Sales Order')
  71            : $self->type eq _purchase_order_type() ? $::locale->text('Edit Purchase Order')
  72            : '',
  73     %{$self->{template_args}}
  74   );
  75 }
  76
  77 sub action_update {
  78   my ($self) = @_;
  79
  80   $self->_pre_render();
  81   $self->render(
  82     'order/form',
  83     title => $self->type eq _sales_order_type()    ? $::locale->text('Edit Sales Order')
  84            : $self->type eq _purchase_order_type() ? $::locale->text('Edit Purchase Order')
  85            : '',
  86     %{$self->{template_args}}
  87   );
  88 }
  89
  90 sub action_delete {
  91   my ($self) = @_;
  92
  93   my $errors = $self->_delete();
  94
  95   if (scalar @{ $errors }) {
  96     $self->js->flash('error', $_) foreach @{ $errors };
  97     return $self->js->render();
  98   }
  99
 100   flash_later('info', $::locale->text('The order has been deleted'));
 101   my @redirect_params = (
 102     action => 'edit',
 103     type   => $self->type,
 104   );
 105
 106   $self->redirect_to(@redirect_params);
 107 }
 108
 109 sub action_save {
 110   my ($self) = @_;
 111
 112   my $errors = $self->_save();
 113
 114   if (scalar @{ $errors }) {
 115     $self->js->flash('error', $_) foreach @{ $errors };
 116     return $self->js->render();
 117   }
 118
 119   flash_later('info', $::locale->text('The order has been saved'));
 120   my @redirect_params = (
 121     action => 'edit',
 122     type   => $self->type,
 123     id     => $self->order->id,
 124   );
 125
 126   $self->redirect_to(@redirect_params);
 127 }
 128
 129 sub action_create_pdf {
 130   my ($self) = @_;
 131
 132   my $pdf;
 133   my @errors = _create_pdf($self->order, \$pdf);
 134   if (scalar @errors) {
 135     return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
 136   }
 137
 138   my $sfile = SL::SessionFile::Random->new(mode => "w");
 139   $sfile->fh->print($pdf);
 140   $sfile->fh->close;
 141
 142   my $key = join('_', Time::HiRes::gettimeofday(), int rand 1000000000000);
 143   $::auth->set_session_value("Order::create_pdf-${key}" => $sfile->file_name);
 144
 145   my $form = Form->new;
 146   $form->{ordnumber} = $self->order->ordnumber;
 147   $form->{formname}  = $self->type;
 148   $form->{type}      = $self->type;
 149   $form->{language}  = 'de';
 150   $form->{format}    = 'pdf';
 151
 152   my $pdf_filename = $form->generate_attachment_filename();
 153
 154   $self->js
 155     ->run('download_pdf', $pdf_filename, $key)
 156     ->flash('info', t8('The PDF has been created'))->render($self);
 157 }
 158
 159 sub action_download_pdf {
 160   my ($self) = @_;
 161
 162   my $key = $::form->{key};
 163   my $tmp_filename = $::auth->get_session_value("Order::create_pdf-${key}");
 164   return $self->send_file(
 165     $tmp_filename,
 166     type => 'application/pdf',
 167     name => $::form->{pdf_filename},
 168   );
 169 }
 170
 171 sub action_show_email_dialog {
 172   my ($self) = @_;
 173
 174   my $cv_method = $self->cv;
 175
 176   if (!$self->order->$cv_method) {
 177     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'))
 178                     ->render($self);
 179   }
 180
 181   $self->{email}->{to}   = $self->order->contact->cp_email if $self->order->contact;
 182   $self->{email}->{to} ||= $self->order->$cv_method->email;
 183   $self->{email}->{cc}   = $self->order->$cv_method->cc;
 184   $self->{email}->{bcc}  = join ', ', grep $_, $self->order->$cv_method->bcc, SL::DB::Default->get->global_bcc;
 185   # Todo: get addresses from shipto, if any
 186
 187   my $form = Form->new;
 188   $form->{ordnumber} = $self->order->ordnumber;
 189   $form->{formname}  = $self->type;
 190   $form->{type}      = $self->type;
 191   $form->{language} = 'de';
 192   $form->{format}   = 'pdf';
 193
 194   $self->{email}->{subject}             = $form->generate_email_subject();
 195   $self->{email}->{attachment_filename} = $form->generate_attachment_filename();
 196   $self->{email}->{message}             = $form->create_email_signature();
 197
 198   my $dialog_html = $self->render('order/tabs/_email_dialog', { output => 0 });
 199   $self->js
 200       ->run('show_email_dialog', $dialog_html)
 201       ->reinit_widgets
 202       ->render($self);
 203 }
 204
 205 # Todo: handling error messages: flash is not displayed in dialog, but in the main form
 206 sub action_send_email {
 207   my ($self) = @_;
 208
 209   my $mail      = Mailer->new;
 210   $mail->{from} = qq|"$::myconfig{name}" <$::myconfig{email}>|;
 211   $mail->{$_}   = $::form->{email}->{$_} for qw(to cc bcc subject message);
 212
 213   my $pdf;
 214   my @errors = _create_pdf($self->order, \$pdf, {media => 'email'});
 215   if (scalar @errors) {
 216     return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
 217   }
 218
 219   $mail->{attachments} = [{ "content" => $pdf,
 220                             "name"    => $::form->{email}->{attachment_filename} }];
 221
 222   if (my $err = $mail->send) {
 223     return $self->js->flash('error', t8('Sending E-mail: ') . $err)
 224                     ->render($self);
 225   }
 226
 227   # internal notes
 228   my $intnotes = $self->order->intnotes;
 229   $intnotes   .= "\n\n" if $self->order->intnotes;
 230   $intnotes   .= t8('[email]')                                                                                        . "\n";
 231   $intnotes   .= t8('Date')       . ": " . $::locale->format_date_object(DateTime->now_local, precision => 'seconds') . "\n";
 232   $intnotes   .= t8('To (email)') . ": " . $mail->{to}                                                                . "\n";
 233   $intnotes   .= t8('Cc')         . ": " . $mail->{cc}                                                                . "\n"    if $mail->{cc};
 234   $intnotes   .= t8('Bcc')        . ": " . $mail->{bcc}                                                               . "\n"    if $mail->{bcc};
 235   $intnotes   .= t8('Subject')    . ": " . $mail->{subject}                                                           . "\n\n";
 236   $intnotes   .= t8('Message')    . ": " . $mail->{message};
 237
 238   $self->js
 239       ->val('#order_intnotes', $intnotes)
 240       ->run('close_email_dialog')
 241       ->render($self);
 242 }
 243
 244 sub action_save_and_delivery_order {
 245   my ($self) = @_;
 246
 247   my $errors = $self->_save();
 248
 249   if (scalar @{ $errors }) {
 250     $self->js->flash('error', $_) foreach @{ $errors };
 251     return $self->js->render();
 252   }
 253   flash_later('info', $::locale->text('The order has been saved'));
 254
 255   my @redirect_params = (
 256     controller => 'oe.pl',
 257     action     => 'oe_delivery_order_from_order',
 258     id         => $self->order->id,
 259   );
 260
 261   $self->redirect_to(@redirect_params);
 262 }
 263
 264 sub action_customer_vendor_changed {
 265   my ($self) = @_;
 266
 267   my $cv_method = $self->cv;
 268
 269   if ($self->order->$cv_method->contacts && scalar @{ $self->order->$cv_method->contacts } > 0) {
 270     $self->js->show('#cp_row');
 271   } else {
 272     $self->js->hide('#cp_row');
 273   }
 274
 275   if ($self->order->$cv_method->shipto && scalar @{ $self->order->$cv_method->shipto } > 0) {
 276     $self->js->show('#shipto_row');
 277   } else {
 278     $self->js->hide('#shipto_row');
 279   }
 280
 281   $self->order->taxzone_id($self->order->$cv_method->taxzone_id);
 282
 283   if ($self->order->is_sales) {
 284     $self->order->taxincluded(defined($self->order->$cv_method->taxincluded_checked)
 285                               ? $self->order->$cv_method->taxincluded_checked
 286                               : $::myconfig{taxincluded_checked});
 287   }
 288
 289   $self->order->payment_id($self->order->$cv_method->payment_id);
 290   $self->order->delivery_term_id($self->order->$cv_method->delivery_term_id);
 291
 292   $self->_recalc();
 293
 294   $self->js
 295     ->replaceWith('#order_cp_id',            $self->build_contact_select)
 296     ->replaceWith('#order_shipto_id',        $self->build_shipto_select)
 297     ->val(        '#order_taxzone_id',       $self->order->taxzone_id)
 298     ->val(        '#order_taxincluded',      $self->order->taxincluded)
 299     ->val(        '#order_payment_id',       $self->order->payment_id)
 300     ->val(        '#order_delivery_term_id', $self->order->delivery_term_id)
 301     ->val(        '#order_intnotes',         $self->order->$cv_method->notes)
 302     ->focus(      '#order_' . $self->cv . '_id');
 303
 304   $self->_js_redisplay_amounts_and_taxes;
 305   $self->js->render();
 306 }
 307
 308 sub action_add_item {
 309   my ($self) = @_;
 310
 311   my $form_attr = $::form->{add_item};
 312
 313   return unless $form_attr->{parts_id};
 314
 315   my $item = SL::DB::OrderItem->new;
 316   $item->assign_attributes(%$form_attr);
 317
 318   my $part        = SL::DB::Part->new(id => $form_attr->{parts_id})->load;
 319   my $cv_method   = $self->cv;
 320   my $cv_discount = $self->order->$cv_method? $self->order->$cv_method->discount : 0.0;
 321
 322   my %new_attr;
 323   $new_attr{part}        = $part;
 324   $new_attr{description} = $part->description if ! $item->description;
 325   $new_attr{qty}         = 1.0                if ! $item->qty;
 326   $new_attr{unit}        = $part->unit;
 327   $new_attr{sellprice}   = $part->sellprice   if ! $item->sellprice;
 328   $new_attr{discount}    = $cv_discount       if ! $item->discount;
 329
 330   # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
 331   # they cannot be retrieved via custom_variables until the order/orderitem is
 332   # saved. Adding empty custom_variables to new orderitem here solves this problem.
 333   $new_attr{custom_variables} = [];
 334
 335   $item->assign_attributes(%new_attr);
 336
 337   $self->order->add_items($item);
 338
 339   $self->_recalc();
 340
 341   my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
 342   my $row_as_html = $self->p->render('order/tabs/_row', ITEM => $item, ID => $item_id);
 343
 344   $self->js
 345     ->append('#row_table_id', $row_as_html)
 346     ->val('.add_item_input', '')
 347     ->run('row_table_scroll_down')
 348     ->run('row_set_keyboard_events_by_id', $item_id)
 349     ->on('.recalc', 'change', 'recalc_amounts_and_taxes')
 350     ->focus('#add_item_parts_id_name');
 351
 352   $self->_js_redisplay_amounts_and_taxes;
 353   $self->js->render();
 354 }
 355
 356 sub action_recalc_amounts_and_taxes {
 357   my ($self) = @_;
 358
 359   $self->_recalc();
 360
 361   $self->_js_redisplay_linetotals;
 362   $self->_js_redisplay_amounts_and_taxes;
 363   $self->js->render();
 364 }
 365
 366 sub _js_redisplay_linetotals {
 367   my ($self) = @_;
 368
 369   my @data = map {$::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0)} @{ $self->order->items };
 370   $self->js
 371     ->run('redisplay_linetotals', \@data);
 372 }
 373
 374 sub _js_redisplay_amounts_and_taxes {
 375   my ($self) = @_;
 376
 377   if (scalar @{ $self->{taxes} }) {
 378     $self->js->show('#taxincluded_row_id');
 379   } else {
 380     $self->js->hide('#taxincluded_row_id');
 381   }
 382
 383   if ($self->order->taxincluded) {
 384     $self->js->hide('#subtotal_row_id');
 385   } else {
 386     $self->js->show('#subtotal_row_id');
 387   }
 388
 389   $self->js
 390     ->html('#netamount_id', $::form->format_amount(\%::myconfig, $self->order->netamount, -2))
 391     ->html('#amount_id',    $::form->format_amount(\%::myconfig, $self->order->amount,    -2))
 392     ->remove('.tax_row')
 393     ->insertBefore($self->build_tax_rows, '#amount_row_id');
 394 }
 395
 396 #
 397 # helpers
 398 #
 399
 400 sub init_valid_types {
 401   [ _sales_order_type(), _purchase_order_type() ];
 402 }
 403
 404 sub init_type {
 405   my ($self) = @_;
 406
 407   if (none { $::form->{type} eq $_ } @{$self->valid_types}) {
 408     die "Not a valid type for order";
 409   }
 410
 411   $self->type($::form->{type});
 412 }
 413
 414 sub init_cv {
 415   my ($self) = @_;
 416
 417   my $cv = $self->type eq _sales_order_type()    ? 'customer'
 418          : $self->type eq _purchase_order_type() ? 'vendor'
 419          : die "Not a valid type for order";
 420
 421   return $cv;
 422 }
 423
 424 sub init_p {
 425   SL::Presenter->get;
 426 }
 427
 428 sub init_order {
 429   _make_order();
 430 }
 431
 432 sub _check_auth {
 433   my ($self) = @_;
 434
 435   my $right_for = { map { $_ => $_.'_edit' } @{$self->valid_types} };
 436
 437   my $right   = $right_for->{ $self->type };
 438   $right    ||= 'DOES_NOT_EXIST';
 439
 440   $::auth->assert($right);
 441 }
 442
 443 sub build_contact_select {
 444   my ($self) = @_;
 445
 446   $self->p->select_tag('order.cp_id', [ $self->order->{$self->cv}->contacts ],
 447                        value_key  => 'cp_id',
 448                        title_key  => 'full_name_dep',
 449                        default    => $self->order->cp_id,
 450                        with_empty => 1,
 451                        style      => 'width: 300px',
 452   );
 453 }
 454
 455 sub build_shipto_select {
 456   my ($self) = @_;
 457
 458   $self->p->select_tag('order.shipto_id', [ $self->order->{$self->cv}->shipto ],
 459                        value_key  => 'shipto_id',
 460                        title_key  => 'displayable_id',
 461                        default    => $self->order->shipto_id,
 462                        with_empty => 1,
 463                        style      => 'width: 300px',
 464   );
 465 }
 466
 467 sub build_tax_rows {
 468   my ($self) = @_;
 469
 470   my $rows_as_html;
 471   foreach my $tax (sort { $a->{tax}->rate cmp $b->{tax}->rate } @{ $self->{taxes} }) {
 472     $rows_as_html .= $self->p->render('order/tabs/_tax_row', TAX => $tax, TAXINCLUDED => $self->order->taxincluded);
 473   }
 474   return $rows_as_html;
 475 }
 476
 477
 478 sub _make_order {
 479   my ($self) = @_;
 480
 481   # add_items adds items to an order with no items for saving, but they cannot
 482   # be retrieved via items until the order is saved. Adding empty items to new
 483   # order here solves this problem.
 484   my $order;
 485   $order   = SL::DB::Manager::Order->find_by(id => $::form->{id}) if $::form->{id};
 486   $order ||= SL::DB::Order->new(orderitems => []);
 487
 488   $order->assign_attributes(%{$::form->{order}});
 489
 490   return $order;
 491 }
 492
 493
 494 sub _recalc {
 495   my ($self) = @_;
 496
 497   # bb: todo: currency later
 498   $self->order->currency_id($::instance_conf->get_currency_id());
 499
 500   my %pat = $self->order->calculate_prices_and_taxes();
 501   $self->{taxes} = [];
 502   foreach my $tax_chart_id (keys %{ $pat{taxes} }) {
 503     my $tax = SL::DB::Manager::Tax->find_by(chart_id => $tax_chart_id);
 504
 505     my @amount_keys = grep { $pat{amounts}->{$_}->{tax_id} == $tax->id } keys %{ $pat{amounts} };
 506     push(@{ $self->{taxes} }, { amount    => $pat{taxes}->{$tax_chart_id},
 507                                 netamount => $pat{amounts}->{$amount_keys[0]}->{amount},
 508                                 tax       => $tax });
 509   }
 510
 511   pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items}, @{$pat{items}};
 512 }
 513
 514
 515 sub _get_unalterable_data {
 516   my ($self) = @_;
 517
 518   foreach my $item (@{ $self->order->items }) {
 519     if ($item->id) {
 520       # load data from orderitems (db)
 521       my $db_item = SL::DB::OrderItem->new(id => $item->id)->load;
 522       $item->$_($db_item->$_) for qw(active_discount_source active_price_source longdescription);
 523     } else {
 524       # set data from part (or other sources)
 525       $item->longdescription($item->part->notes);
 526       #$item->active_price_source('');
 527       #$item->active_discount_source('');
 528     }
 529
 530     # autovivify all cvars that are not in the form (cvars_by_config can do it).
 531     # workaround to pre-parse number-cvars (parse_custom_variable_values does not parse number values).
 532     foreach my $var (@{ $item->cvars_by_config }) {
 533       $var->unparsed_value($::form->parse_amount(\%::myconfig, $var->{__unparsed_value})) if ($var->config->type eq 'number' && exists($var->{__unparsed_value}));
 534     }
 535     $item->parse_custom_variable_values;
 536   }
 537 }
 538
 539
 540 sub _delete {
 541   my ($self) = @_;
 542
 543   my $errors = [];
 544   my $db = $self->order->db;
 545
 546   $db->do_transaction(
 547     sub {
 548       my @spoolfiles = grep { $_ } map { $_->spoolfile } @{ SL::DB::Manager::Status->get_all(where => [ trans_id => $self->order->id ]) };
 549       $self->order->delete;
 550       my $spool = $::lx_office_conf{paths}->{spool};
 551       unlink map { "$spool/$_" } @spoolfiles if $spool;
 552
 553       1;
 554   }) || push(@{$errors}, $db->error);
 555
 556   return $errors;
 557 }
 558
 559
 560 sub _save {
 561   my ($self) = @_;
 562
 563   my $errors = [];
 564   my $db = $self->order->db;
 565
 566   $db->do_transaction(
 567     sub {
 568       $self->order->save();
 569   }) || push(@{$errors}, $db->error);
 570
 571   return $errors;
 572 }
 573
 574
 575 sub _pre_render {
 576   my ($self) = @_;
 577
 578   $self->{all_taxzones}        = SL::DB::Manager::TaxZone->get_all_sorted();
 579   $self->{all_employees}       = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->employee_id,
 580                                                                                        deleted => 0 ] ],
 581                                                                     sort_by => 'name');
 582   $self->{all_salesmen}        = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->salesman_id,
 583                                                                                        deleted => 0 ] ],
 584                                                                     sort_by => 'name');
 585   $self->{all_projects}        = SL::DB::Manager::Project->get_all(where => [ or => [ id => $self->order->globalproject_id,
 586                                                                                       active => 1 ] ],
 587                                                                    sort_by => 'projectnumber');
 588   $self->{all_payment_terms}   = SL::DB::Manager::PaymentTerm->get_all_sorted();
 589   $self->{all_delivery_terms}  = SL::DB::Manager::DeliveryTerm->get_all_sorted();
 590
 591   $self->{current_employee_id} = SL::DB::Manager::Employee->current->id;
 592
 593   $::request->{layout}->use_javascript("${_}.js")  for qw(ckeditor/ckeditor ckeditor/adapters/jquery);
 594 }
 595
 596 sub _create_pdf {
 597   my ($order, $pdf_ref, $params) = @_;
 598
 599   my $print_form = Form->new('');
 600   $print_form->{type}     = $order->type;
 601   $print_form->{formname} = $order->type;
 602   $print_form->{format}   = $params->{format} || 'pdf',
 603   $print_form->{media}    = $params->{media}  || 'file';
 604
 605   $order->flatten_to_form($print_form, format_amounts => 1);
 606   # flatten_to_form sets payment_terms from customer/vendor - we do not want that here
 607   delete $print_form->{payment_terms} if !$print_form->{payment_id};
 608
 609   my @errors = ();
 610   $print_form->throw_on_error(sub {
 611     eval {
 612       $print_form->prepare_for_printing;
 613
 614       $$pdf_ref = SL::Helper::CreatePDF->create_pdf(
 615         template  => SL::Helper::CreatePDF->find_template(name => $print_form->{formname}),
 616         variables => $print_form,
 617         variable_content_types => {
 618           longdescription => 'html',
 619           partnotes       => 'html',
 620           notes           => 'html',
 621         },
 622       );
 623       1;
 624     } || push @errors, ref($EVAL_ERROR) eq 'SL::X::FormError' ? $EVAL_ERROR->getMessage : $EVAL_ERROR;
 625   });
 626
 627   return @errors;
 628 }
 629
 630 sub _sales_order_type {
 631   'sales_order';
 632 }
 633
 634 sub _purchase_order_type {
 635   'purchase_order';
 636 }
 637
 638 1;