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) ]);
  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 $print_form = Form->new('');
 111   $print_form->{type}     = 'sales_order';
 112   $print_form->{formname} = 'sales_order',
 113   $print_form->{format}   = 'pdf',
 114   $print_form->{media}    = 'file';
 115
 116   $self->order->flatten_to_form($print_form, format_amounts => 1);
 117
 118   my $pdf;
 119   my @errors;
 120   $print_form->throw_on_error(sub {
 121     eval {
 122       $print_form->prepare_for_printing;
 123
 124       $pdf = SL::Helper::CreatePDF->create_pdf(
 125         template  => SL::Helper::CreatePDF->find_template(name => $print_form->{formname}),
 126         variables => $print_form,
 127       );
 128       1;
 129     } || push @errors, ref($EVAL_ERROR) eq 'SL::X::FormError' ? $EVAL_ERROR->getMessage : $EVAL_ERROR;
 130   });
 131
 132   if (scalar @errors) {
 133     return $self->js->flash('error', t8('Conversion to PDF failed: #1', $errors[0]))->render($self);
 134   }
 135
 136   my $sfile = SL::SessionFile::Random->new(mode => "w");
 137   $sfile->fh->print($pdf);
 138   $sfile->fh->close;
 139
 140   my $tmp_filename = $sfile->file_name;
 141   my $pdf_filename = t8('Sales Order') . '_' . $self->order->ordnumber . '.pdf';
 142
 143   $self->js
 144     ->run('download_pdf', $tmp_filename, $pdf_filename)
 145     ->flash('info', t8('The PDF has been created'))->render($self);
 146 }
 147
 148 sub action_download_pdf {
 149   my ($self) = @_;
 150
 151   return $self->send_file(
 152     $::form->{tmp_filename},
 153     type => 'application/pdf',
 154     name => $::form->{pdf_filename},
 155   );
 156 }
 157
 158 sub action_customer_vendor_changed {
 159   my ($self) = @_;
 160
 161   if ($self->cv eq 'customer') {
 162     $self->order->customer(SL::DB::Manager::Customer->find_by_or_create(id => $::form->{cv_id}));
 163
 164   } elsif ($self->cv eq 'vendor') {
 165     $self->order->vendor(SL::DB::Manager::Vendor->find_by_or_create(id => $::form->{cv_id}));
 166   }
 167
 168   if ($self->order->{$self->cv}->contacts && scalar @{ $self->order->{$self->cv}->contacts } > 0) {
 169     $self->js->show('#cp_row');
 170   } else {
 171     $self->js->hide('#cp_row');
 172   }
 173
 174   if ($self->order->{$self->cv}->shipto && scalar @{ $self->order->{$self->cv}->shipto } > 0) {
 175     $self->js->show('#shipto_row');
 176   } else {
 177     $self->js->hide('#shipto_row');
 178   }
 179
 180   $self->js
 181     ->replaceWith('#order_cp_id',     $self->build_contact_select)
 182     ->replaceWith('#order_shipto_id', $self->build_shipto_select)
 183     ->val('#order_taxzone_id', $self->order->{$self->cv}->taxzone_id)
 184     ->focus('#order_' . $self->cv . '_id')
 185     ->render($self);
 186 }
 187
 188 sub action_add_item {
 189   my ($self) = @_;
 190
 191   my $form_attr = $::form->{add_item};
 192
 193   return unless $form_attr->{parts_id};
 194
 195   my $item = SL::DB::OrderItem->new;
 196   $item->assign_attributes(%$form_attr);
 197
 198   my $part        = SL::DB::Part->new(id => $form_attr->{parts_id})->load;
 199   my $cv_method   = $self->cv;
 200   my $cv_discount = $self->order->$cv_method? $self->order->$cv_method->discount : 0.0;
 201
 202   my %new_attr;
 203   $new_attr{part}        = $part;
 204   $new_attr{description} = $part->description if ! $item->description;
 205   $new_attr{qty}         = 1.0                if ! $item->qty;
 206   $new_attr{unit}        = $part->unit;
 207   $new_attr{sellprice}   = $part->sellprice   if ! $item->sellprice;
 208   $new_attr{discount}    = $cv_discount       if ! $item->discount;
 209
 210   # add_custom_variables adds cvars to an orderitem with no cvars for saving, but
 211   # they cannot be retrieved via custom_variables until the order/orderitem is
 212   # saved. Adding empty custom_variables to new orderitem here solves this problem.
 213   $new_attr{custom_variables} = [];
 214
 215   $item->assign_attributes(%new_attr);
 216
 217   $self->order->add_items($item);
 218
 219   $self->_recalc();
 220
 221   my $item_id = join('_', 'new', Time::HiRes::gettimeofday(), int rand 1000000000000);
 222   my $row_as_html = $self->p->render('order/tabs/_row', ITEM => $item, ID => $item_id);
 223
 224   $self->js
 225     ->append('#row_table_id', $row_as_html)
 226     ->val('#add_item_parts_id', '')
 227     ->val('#add_item_parts_id_name', '')
 228     ->val('#add_item_description', '')
 229     ->val('#add_item_qty_as_number', '')
 230     ->val('#add_item_sellprice_as_number', '')
 231     ->val('#add_item_discount_as_percent', '')
 232     ->run('row_table_scroll_down')
 233     ->run('row_set_keyboard_events_by_id', $item_id)
 234     ->on('.recalc', 'change', 'recalc_amounts_and_taxes')
 235     ->focus('#add_item_parts_id_name');
 236
 237   $self->_js_redisplay_amounts_and_taxes;
 238   $self->js->render($self);
 239 }
 240
 241 sub action_recalc_amounts_and_taxes {
 242   my ($self) = @_;
 243
 244   $self->_recalc();
 245
 246   $self->_js_redisplay_linetotals;
 247   $self->_js_redisplay_amounts_and_taxes;
 248   $self->js->render($self);
 249 }
 250
 251 sub _js_redisplay_linetotals {
 252   my ($self) = @_;
 253
 254   my @data = map {$::form->format_amount(\%::myconfig, $_->{linetotal}, 2, 0)} @{ $self->order->items };
 255   $self->js
 256     ->run('redisplay_linetotals', \@data);
 257 }
 258
 259 sub _js_redisplay_amounts_and_taxes {
 260   my ($self) = @_;
 261
 262   $self->js
 263     ->html('#netamount_id', $::form->format_amount(\%::myconfig, $self->order->netamount, -2))
 264     ->html('#amount_id',    $::form->format_amount(\%::myconfig, $self->order->amount,    -2))
 265     ->remove('.tax_row')
 266     ->insertBefore($self->build_tax_rows, '#amount_row_id');
 267 }
 268
 269 #
 270 # helpers
 271 #
 272
 273 sub init_valid_types {
 274   [ _sales_order_type(), _purchase_order_type() ];
 275 }
 276
 277 sub init_type {
 278   my ($self) = @_;
 279
 280   if (none { $::form->{type} eq $_ } @{$self->valid_types}) {
 281     die "Not a valid type for order";
 282   }
 283
 284   $self->type($::form->{type});
 285 }
 286
 287 sub init_cv {
 288   my ($self) = @_;
 289
 290   my $cv = $self->type eq _sales_order_type()    ? 'customer'
 291          : $self->type eq _purchase_order_type() ? 'vendor'
 292          : die "Not a valid type for order";
 293
 294   return $cv;
 295 }
 296
 297 sub init_js {
 298   SL::ClientJS->new;
 299 }
 300
 301 sub init_p {
 302   SL::Presenter->get;
 303 }
 304
 305 sub init_order {
 306   _make_order();
 307 }
 308
 309 sub _check_auth {
 310   my ($self) = @_;
 311
 312   my $right_for = { map { $_ => $_.'_edit' } @{$self->valid_types} };
 313
 314   my $right   = $right_for->{ $self->type };
 315   $right    ||= 'DOES_NOT_EXIST';
 316
 317   $::auth->assert($right);
 318 }
 319
 320 sub build_contact_select {
 321   my ($self) = @_;
 322
 323   $self->p->select_tag('order.cp_id', [ $self->order->{$self->cv}->contacts ],
 324                        value_key  => 'cp_id',
 325                        title_key  => 'full_name_dep',
 326                        default    => $self->order->cp_id,
 327                        with_empty => 1,
 328                        style      => 'width: 300px',
 329   );
 330 }
 331
 332 sub build_shipto_select {
 333   my ($self) = @_;
 334
 335   $self->p->select_tag('order.shipto_id', [ $self->order->{$self->cv}->shipto ],
 336                        value_key  => 'shipto_id',
 337                        title_key  => 'displayable_id',
 338                        default    => $self->order->shipto_id,
 339                        with_empty => 1,
 340                        style      => 'width: 300px',
 341   );
 342 }
 343
 344 sub build_tax_rows {
 345   my ($self) = @_;
 346
 347   my $rows_as_html;
 348   foreach my $tax (@{ $self->{taxes} }) {
 349     $rows_as_html .= $self->p->render('order/tabs/_tax_row', TAX => $tax);
 350   }
 351   return $rows_as_html;
 352 }
 353
 354
 355 sub _make_order {
 356   my ($self) = @_;
 357
 358   # add_items adds items to an order with no items for saving, but they cannot
 359   # be retrieved via items until the order is saved. Adding empty items to new
 360   # order here solves this problem.
 361   my $order;
 362   $order   = SL::DB::Manager::Order->find_by(id => $::form->{id}) if $::form->{id};
 363   $order ||= SL::DB::Order->new(orderitems => []);
 364
 365   $order->assign_attributes(%{$::form->{order}});
 366
 367   return $order;
 368 }
 369
 370
 371 sub _recalc {
 372   my ($self) = @_;
 373
 374   # bb: todo: currency later
 375   $self->order->currency_id($::instance_conf->get_currency_id());
 376
 377   my %pat = $self->order->calculate_prices_and_taxes();
 378
 379   foreach my $tax_chart_id (keys %{ $pat{taxes} }) {
 380     my $tax = SL::DB::Manager::Tax->find_by(chart_id => $tax_chart_id);
 381     push(@{ $self->{taxes} }, { amount => $pat{taxes}->{$tax_chart_id},
 382                                 tax    => $tax });
 383   }
 384
 385   pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items}, @{$pat{items}};
 386 }
 387
 388 sub _save {
 389   my ($self) = @_;
 390
 391   # autovivify all cvars that are not in the form (cvars_by_config can do it)
 392   foreach my $item (@{ $self->order->items }) {
 393     $item->cvars_by_config;
 394   }
 395
 396   my $errors = [];
 397   my $db = $self->order->db;
 398
 399   $db->do_transaction(
 400     sub {
 401       $self->order->save();
 402   }) || push(@{$errors}, $db->error);
 403
 404   return $errors;
 405 }
 406
 407
 408 sub _pre_render {
 409   my ($self) = @_;
 410
 411   $self->{all_taxzones}        = SL::DB::Manager::TaxZone->get_all_sorted();
 412   $self->{all_employees}       = SL::DB::Manager::Employee->get_all(where => [ or => [ id => $self->order->employee_id,
 413                                                                                        deleted => 0 ] ],
 414                                                                     sort_by => 'name');
 415   $self->{all_projects}        = SL::DB::Manager::Project->get_all(where => [ or => [ id => $self->order->globalproject_id,
 416                                                                                       active => 1 ] ],
 417                                                                    sort_by => 'projectnumber');
 418   $self->{all_payment_terms}   = SL::DB::Manager::PaymentTerm->get_all_sorted();
 419   $self->{all_delivery_terms}  = SL::DB::Manager::DeliveryTerm->get_all_sorted();
 420
 421   $self->{current_employee_id} = SL::DB::Manager::Employee->current->id;
 422
 423   $::request->{layout}->use_javascript("${_}.js")  for qw(ckeditor/ckeditor ckeditor/adapters/jquery);
 424 }
 425
 426 sub _sales_order_type {
 427   'sales_order';
 428 }
 429
 430 sub _purchase_order_type {
 431   'purchase_order';
 432 }
 433
 434 1;