SL/Controller/PriceRule.pm

   1 package SL::Controller::PriceRule;
   2
   3 use strict;
   4
   5 use parent qw(SL::Controller::Base);
   6
   7 use SL::Controller::Helper::GetModels;
   8 use SL::Controller::Helper::ParseFilter;
   9 use SL::Controller::Helper::ReportGenerator;
  10 use SL::DB::PriceRule;
  11 use SL::DB::PriceRuleItem;
  12 use SL::DB::Pricegroup;
  13 use SL::DB::PartsGroup;
  14 use SL::DB::Business;
  15 use SL::Helper::Flash;
  16 use SL::Locale::String;
  17
  18 use Rose::Object::MakeMethods::Generic
  19 (
  20  'scalar --get_set_init' => [ qw(models price_rule vc pricegroups partsgroups businesses cvar_configs) ],
  21 );
  22
  23 # __PACKAGE__->run_before('check_auth');
  24 __PACKAGE__->run_before('add_javascripts');
  25
  26 #
  27 # actions
  28 #
  29
  30 sub action_list {
  31   my ($self) = @_;
  32
  33   $self->make_filter_summary;
  34
  35   my $price_rules = $self->models->get;
  36
  37   $self->setup_search_action_bar;
  38
  39   $self->prepare_report;
  40
  41   $self->report_generator_list_objects(report => $self->{report}, objects => $price_rules, $::form->{inline} ? (layout => 0, header => 0) : ());
  42 }
  43
  44 sub action_new {
  45   my ($self) = @_;
  46
  47   $self->price_rule(SL::DB::PriceRule->new);
  48   $self->price_rule->assign_attributes(%{ $::form->{price_rule} || {} });
  49   $self->display_form;
  50 }
  51
  52 sub action_edit {
  53   my ($self) = @_;
  54
  55   $self->display_form;
  56 }
  57
  58 sub action_create {
  59   my ($self) = @_;
  60
  61   $self->price_rule($self->price_rule->clone_and_reset_deep);
  62   $self->create_or_update;
  63 }
  64
  65 sub action_update {
  66   my ($self) = @_;
  67   $self->create_or_update;
  68 }
  69
  70  #TODO
  71 sub action_destroy {
  72   my ($self) = @_;
  73
  74   $self->price_rule->delete;
  75   flash_later('info',  $::locale->text('The price rule has been deleted.'));
  76
  77   $self->redirect_to($::form->{callback} || (action => 'list'));
  78 }
  79
  80 sub action_add_item_row {
  81   my ($self, %params) = @_;
  82
  83   my $item = $::form->{type} =~ m{cvar/(\d+)}
  84     ? SL::DB::PriceRuleItem->new(type => 'cvar', custom_variable_configs_id => $1)
  85     : SL::DB::PriceRuleItem->new(type => $::form->{type});
  86
  87   my $html = $self->render('price_rule/item', { output => 0 }, item => $item);
  88
  89   $self
  90     ->js
  91     ->before('#price_rule_new_items', $html)
  92     ->reinit_widgets
  93     ->render;
  94 }
  95
  96 sub action_price_type_help {
  97   $_[0]->render('price_rule/price_type_help', { layout => 0 });
  98 }
  99
 100 #
 101 # filters
 102 #
 103
 104 sub check_auth {
 105   $::auth->assert('price_rule_edit');
 106 }
 107
 108 #
 109 # helpers
 110 #
 111
 112 sub display_form {
 113   my ($self, %params) = @_;
 114   my $is_new  = !$self->price_rule->id;
 115   my $title   = $self->form_title(($is_new ? 'create' : 'edit'), $self->price_rule->type);
 116   $self->setup_form_action_bar;
 117   $self->render('price_rule/form',
 118     title => $title,
 119     %params
 120   );
 121 }
 122
 123 sub form_title {
 124   my ($self, $action, $type) = @_;
 125
 126   return {
 127     edit => {
 128       customer => t8('Edit sales price rule'),
 129       vendor   => t8('Edit purchase price rule'),
 130       ''       => t8('Edit price rule'),
 131     },
 132     create => {
 133       customer => t8('Create a new sales price rule'),
 134       vendor   => t8('Create a new purchase price rule'),
 135       ''       => t8('Create a new price rule'),
 136     },
 137     list => {
 138       customer => t8('Sales Price Rules'),
 139       vendor   => t8('Purchase Price Rules'),
 140       ''       => t8('Price Rules'),
 141     },
 142   }->{$action}{$type};
 143 }
 144
 145 sub create_or_update {
 146   my $self   = shift;
 147   my $is_new = !$self->price_rule->id;
 148   my $params = delete($::form->{price_rule}) || { };
 149
 150   delete $params->{id};
 151   $self->price_rule->assign_attributes(%{ $params });
 152
 153   my @errors = $self->price_rule->validate;
 154
 155   if (@errors) {
 156     flash('error', @errors);
 157     $self->display_form(callback => $::form->{callback});
 158     return;
 159   }
 160
 161   $self->price_rule->save;
 162
 163   flash_later('info', $is_new ? $::locale->text('The price rule has been created.') : $::locale->text('The price rule has been saved.'));
 164
 165   $self->redirect_to($::form->{callback} || (action => 'list', 'filter.type' => $self->price_rule->type));
 166 }
 167
 168 sub prepare_report {
 169   my ($self)      = @_;
 170
 171   my $callback    = $self->models->get_callback;
 172
 173   my $report      = SL::ReportGenerator->new(\%::myconfig, $::form);
 174   $self->{report} = $report;
 175
 176   my @columns     = qw(name type priority price reduction discount items);
 177   my @sortable    = qw(name type priority price reduction discount      );
 178
 179   my %column_defs = (
 180     name          => { obj_link => sub { $self->url_for(action => 'edit', 'price_rule.id' => $_[0]->id, callback => $callback) } },
 181     priority      => { sub  => sub { $_[0]->priority_as_text } },
 182     price         => { sub  => sub { $_[0]->price_as_number } },
 183     reduction     => { sub  => sub { $_[0]->reduction_as_number } },
 184     discount      => { sub  => sub { $_[0]->discount_as_number } },
 185     obsolete      => { sub  => sub { $_[0]->obsolete_as_bool_yn } },
 186     items         => { sub  => sub { $_[0]->item_summary } },
 187   );
 188
 189   map { $column_defs{$_}->{text} ||= $::locale->text( $self->models->get_sort_spec->{$_}->{title} ) } keys %column_defs;
 190
 191   if ( $report->{options}{output_format} =~ /^(pdf|csv)$/i ) {
 192     $self->models->disable_plugin('paginated');
 193   }
 194
 195   my $title        = t8('Price Rules');
 196   $report->{title} = $title; #for browser titlebar (title-tag)
 197
 198   $report->set_options(
 199     std_column_visibility => 1,
 200     controller_class      => 'PriceRule',
 201     output_format         => 'HTML',
 202     title                 => $self->form_title('list', $self->vc),
 203     allow_pdf_export      => !$::form->{inline},
 204     allow_csv_export      => !$::form->{inline},
 205   );
 206   $report->set_columns(%column_defs);
 207   $report->set_column_order(@columns);
 208   $report->set_export_options(qw(list filter));
 209   $report->set_options_from_form;
 210   $self->models->get_models_url_params(sub{ map { $_ => $::form->{$_} } qw(inline) });
 211   $self->models->set_report_generator_sort_options(report => $report, sortable_columns => \@sortable);
 212   $report->set_options(
 213     raw_bottom_info_text  => $self->render('price_rule/report_bottom', { output => 0 }),
 214     raw_top_info_text     => $self->render('price_rule/report_top', { output => 0 }),
 215   );
 216 }
 217
 218 sub make_filter_summary {
 219   my ($self) = @_;
 220
 221   my $filter = $::form->{filter} || {};
 222   my @filter_strings;
 223
 224   my @filters = (
 225     [ $filter->{"name:substr::ilike"}, t8('Name')  ],
 226     [ $filter->{"price:number"},       t8('Price') ],
 227     [ $filter->{"discount:number"},    t8('Discount') ],
 228   );
 229
 230   for (@filters) {
 231     push @filter_strings, "$_->[1]: $_->[0]" if $_->[0];
 232   }
 233
 234   if ($filter->{has_item_type}) {
 235     push @filter_strings, sprintf "%s: %s", t8('Has item type'), join ', ', map {
 236       SL::DB::Manager::PriceRuleItem->get_type($_)->{description}
 237     } @{ $filter->{has_item_type} || [] };
 238   }
 239
 240   $self->{filter_summary} = join ', ', @filter_strings;
 241 }
 242
 243 sub all_price_rule_item_types {
 244   my $item_types = SL::DB::Manager::PriceRuleItem->get_all_types($_[0]->vc || $_[0]->price_rule->type);
 245   my @cvar_types = map [ "cvar/" . $_->id, $_->presenter->description_with_module ], @{$_[0]->cvar_configs };
 246
 247   [ @$item_types, @cvar_types ];
 248 }
 249
 250 sub add_javascripts  {
 251   $::request->{layout}->add_javascripts(qw(kivi.PriceRule.js autocomplete_vendor.js kivi.Part.js kivi.CustomerVendor.js));
 252 }
 253
 254 sub init_price_rule {
 255   my ($self) = @_;
 256
 257   my $price_rule = $::form->{price_rule}{id} ? SL::DB::PriceRule->new(id => $::form->{price_rule}{id})->load : SL::DB::PriceRule->new;
 258
 259   my $items = delete $::form->{price_rule}{items};
 260
 261   $price_rule->assign_attributes(%{ $::form->{price_rule} || {} });
 262
 263   my %old_items = map { $_->id => $_ } $price_rule->items;
 264
 265   my @items;
 266   for my $raw_item (@$items) {
 267     my $item = $raw_item->{id}
 268       ? $old_items{ $raw_item->{id} } || SL::DB::PriceRuleItem->new(id => $raw_item->{id})->load
 269       : SL::DB::PriceRuleItem->new;
 270     $item->assign_attributes(%$raw_item);
 271     push @items, $item;
 272   }
 273
 274   $price_rule->items(@items) if @items;
 275
 276   $self->price_rule($price_rule);
 277 }
 278
 279 sub init_vc {
 280   $::form->{filter}{type};
 281 }
 282
 283 sub init_businesses {
 284   SL::DB::Manager::Business->get_all;
 285 }
 286
 287 sub init_pricegroups {
 288   SL::DB::Manager::Pricegroup->get_all_sorted;
 289 }
 290
 291 sub init_partsgroups {
 292   SL::DB::Manager::PartsGroup->get_all;
 293 }
 294
 295 sub init_cvar_configs {
 296   # eligible cvars for this are all that are reachable from a record or recorditem (all modules but requirement spec)
 297   # and of a type that price rules support (currently: id-based with picker, numeric or date) and by special request select
 298   SL::DB::Manager::CustomVariableConfig->get_all(where => [
 299     "!module" => 'RequirementSpecs',
 300     type => [ qw(timestamp date number integer customer vendor part select) ],
 301   ]) ;
 302 }
 303
 304
 305 sub all_price_types {
 306   SL::DB::Manager::PriceRule->all_price_types;
 307 }
 308
 309 sub init_models {
 310   my ($self) = @_;
 311
 312   SL::Controller::Helper::GetModels->new(
 313     controller => $self,
 314     sorted => {
 315       name     => t8('Name'),
 316       type     => t8('Type'),
 317       priority => t8('Priority'),
 318       price    => t8('Price'),
 319       discount => t8('Discount'),
 320       reduction => t8('Reduced Master Data'),
 321       obsolete => t8('Obsolete'),
 322       items    => t8('Rule Details'),
 323     },
 324   );
 325 }
 326
 327 sub setup_search_action_bar {
 328   my ($self, %params) = @_;
 329
 330   return if $::form->{inline};
 331
 332   for my $bar ($::request->layout->get('actionbar')) {
 333     $bar->add(
 334       action => [
 335         t8('Update'),
 336         submit    => [ '#search_form', { action => 'PriceRule/list' } ],
 337         accesskey => 'enter',
 338       ],
 339
 340       combobox => [
 341         action => [
 342           t8('Add'),
 343         ],
 344         link => [
 345           t8('New Sales Price Rule'),
 346           link => $self->url_for(action => 'new', 'price_rule.type' => 'customer', callback => $self->models->get_callback),
 347         ],
 348         link => [
 349           t8('New Purchase Price Rule'),
 350           link => $self->url_for(action => 'new', 'price_rule.type' => 'vendor', callback => $self->models->get_callback),
 351         ],
 352       ], # end of combobox "Add"
 353     );
 354   }
 355 }
 356
 357 sub setup_form_action_bar {
 358   my ($self) = @_;
 359
 360   my $is_new = !$self->price_rule->id;
 361
 362   for my $bar ($::request->layout->get('actionbar')) {
 363     $bar->add(
 364       combobox => [
 365         action => [
 366           $is_new ? t8('Create') : t8('Save'),
 367           submit    => [ '#form', { action => 'PriceRule/' . ($is_new ? 'create' : 'update') } ],
 368           accesskey => 'enter',
 369         ],
 370         action => [
 371           t8('Use as new'),
 372           submit   => [ '#form', { action => 'PriceRule/create' } ],
 373           disabled => $is_new ? t8('The object has not been saved yet.') : undef,
 374         ],
 375       ], # end of combobox "Save"
 376
 377       action => [
 378         t8('Delete'),
 379         submit   => [ '#form', { action => 'PriceRule/destroy' } ],
 380         confirm  => t8('Do you really want to delete this object?'),
 381         disabled => $is_new                   ? t8('The object has not been saved yet.')
 382                   : $self->price_rule->in_use ? t8('This object has already been used.')
 383                   :                             undef,
 384       ],
 385
 386       link => [
 387         t8('Abort'),
 388         link => $self->url_for(action => 'list', 'filter.type' => $self->price_rule->type),
 389       ],
 390     );
 391   }
 392 }
 393
 394 1;