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