Merge branch 'master' of github.com:kivitendo/kivitendo-erp
[kivitendo-erp.git] / SL / Controller / CustomVariableConfig.pm
1 package SL::Controller::CustomVariableConfig;
2
3 use strict;
4
5 use parent qw(SL::Controller::Base);
6
7 use List::Util qw(first);
8
9 use SL::DB::CustomVariableConfig;
10 use SL::DB::CustomVariableValidity;
11 use SL::DB::PartsGroup;
12 use SL::Helper::Flash;
13 use SL::Locale::String;
14 use Data::Dumper;
15
16 use Rose::Object::MakeMethods::Generic (
17   scalar                  => [ qw(config module module_description flags) ],
18   'scalar --get_set_init' => [ qw(translated_types modules) ],
19 );
20
21 __PACKAGE__->run_before('check_auth');
22 __PACKAGE__->run_before('check_module');
23 __PACKAGE__->run_before('load_config', only => [ qw(edit update destroy) ]);
24
25 our %translations = (
26   text      => t8('Free-form text'),
27   textfield => t8('Text field'),
28   number    => t8('Number'),
29   date      => t8('Date'),
30   timestamp => t8('Timestamp'),
31   bool      => t8('Yes/No (Checkbox)'),
32   select    => t8('Selection'),
33   customer  => t8('Customer'),
34   vendor    => t8('Vendor'),
35   part      => t8('Part'),
36 );
37
38 our @types = qw(text textfield number date bool select customer vendor part); # timestamp
39
40 #
41 # actions
42 #
43
44 sub action_list {
45   my ($self) = @_;
46
47   my $configs = SL::DB::Manager::CustomVariableConfig->get_all_sorted(where => [ module => $self->module ]);
48
49   $::form->header;
50   $self->render('custom_variable_config/list',
51                 title   => t8('List of custom variables'),
52                 CONFIGS => $configs);
53 }
54
55 sub action_new {
56   my ($self) = @_;
57
58   $self->config(SL::DB::CustomVariableConfig->new(module => $self->module));
59   $self->show_form(title => t8('Add custom variable'));
60 }
61
62 sub show_form {
63   my ($self, %params) = @_;
64
65   $self->flags({
66     map { split m/=/, $_, 2 }
67     split m/:/, ($self->config->flags || '')
68   });
69
70   $params{all_partsgroups} = SL::DB::Manager::PartsGroup->get_all();
71
72   $::request->layout->use_javascript("${_}.js") for qw(jquery.selectboxes jquery.multiselect2side);
73   $self->render('custom_variable_config/form', %params);
74 }
75
76 sub action_edit {
77   my ($self) = @_;
78
79   $self->show_form(title => t8('Edit custom variable'));
80 }
81
82 sub action_create {
83   my ($self) = @_;
84
85   $self->config(SL::DB::CustomVariableConfig->new);
86   $self->create_or_update;
87 }
88
89 sub action_update {
90   my ($self) = @_;
91   $self->create_or_update;
92 }
93
94 sub action_destroy {
95   my ($self) = @_;
96
97   # delete relationship to partsgroups (for filter) before cvar can be deleted
98   $self->config->update_attributes(partsgroups => []);
99
100   if (eval { $self->config->delete; 1; }) {
101     flash_later('info',  t8('The custom variable has been deleted.'));
102   } else {
103     flash_later('error', t8('The custom variable is in use and cannot be deleted.'));
104   }
105
106   $self->redirect_to(action => 'list', module => $self->module);
107 }
108
109 sub action_reorder {
110   my ($self) = @_;
111
112   SL::DB::CustomVariableConfig->reorder_list(@{ $::form->{cvarcfg_id} || [] });
113
114   $self->render(\'', { type => 'json' }); # ' make emacs happy
115 }
116
117 #
118 # filters
119 #
120
121 sub check_auth {
122   $::auth->assert('config');
123 }
124
125 sub check_module {
126   my ($self)          = @_;
127
128   $::form->{module} ||= 'CT';
129   my $mod_desc        = first { $_->{module} eq $::form->{module} } @{ $self->modules };
130   die "Invalid 'module' parameter '" . $::form->{module} . "'" if !$mod_desc;
131
132   $self->module($mod_desc->{module});
133   $self->module_description($mod_desc->{description});
134 }
135
136 sub load_config {
137   my ($self) = @_;
138
139   $self->config(SL::DB::CustomVariableConfig->new(id => $::form->{id})->load);
140 }
141
142 #
143 # helpers
144 #
145
146 sub get_translation {
147   my ($self, $type) = @_;
148
149   return $translations{$type};
150 }
151
152 sub init_translated_types {
153   my ($self) = @_;
154
155   return [ map { { type => $_, translation => $translations{$_} } } @types ];
156 }
157
158 sub init_modules {
159   my ($self, %params) = @_;
160
161   return [ sort { $a->{description}->translated cmp $b->{description}->translated } (
162     { module => 'CT',               description => t8('Customers and vendors')          },
163     { module => 'Contacts',         description => t8('Contact persons')                },
164     { module => 'IC',               description => t8('Parts, services and assemblies') },
165     { module => 'Projects',         description => t8('Projects')                       },
166     { module => 'RequirementSpecs', description => t8('Requirement Specs')              },
167   )];
168 }
169
170 sub create_or_update {
171   my ($self) = @_;
172   my $is_new = !$self->config->id;
173
174   my $params = delete($::form->{config}) || { };
175   delete $params->{id};
176
177   if ($self->module eq 'IC') {
178     $params->{partsgroups} = [] if !$params->{flag_partsgroup_filter};
179   } else {
180     delete $params->{flag_partsgroup_filter};
181     $params->{partsgroups} = [];
182   }
183
184   $params->{partsgroups}       ||= []; # The list is empty, if control is not send by the browser.
185   $params->{default_value}       = $::form->parse_amount(\%::myconfig, $params->{default_value}) if $params->{type} eq 'number';
186   $params->{included_by_default} = 0                                                             if !$params->{includeable};
187   $params->{flags}               = join ':', map { m/^flag_(.*)/; "${1}=" . delete($params->{$_}) } grep { m/^flag_/ } keys %{ $params };
188
189   $self->config->assign_attributes(%{ $params }, module => $self->module);
190
191   my @errors = $self->config->validate;
192
193   if (@errors) {
194     flash('error', @errors);
195     $self->show_form(title => $is_new ? t8('Add new custom variable') : t8('Edit custom variable'));
196     return;
197   }
198
199   my $dbh = $self->config->db;
200   $dbh->begin_work;
201
202   $self->config->save;
203   $self->_set_cvar_validity() if $is_new;
204
205   $dbh->commit;
206
207   flash_later('info', $is_new ? t8('The custom variable has been created.') : t8('The custom variable has been saved.'));
208   $self->redirect_to(action => 'list', module => $self->module);
209 }
210
211 sub _set_cvar_validity {
212   my ($self) = @_;
213
214   my $flags = {
215     map { split m/=/, $_, 2 }
216     split m/:/, ($self->config->flags || '')
217   };
218
219   # nothing to do to set valid
220   return if !$flags->{defaults_to_invalid};
221
222   my $all_parts  = SL::DB::Manager::Part->get_all(where => [ or => [ obsolete => 0, obsolete => undef ] ]);
223   foreach my $part (@{ $all_parts }) {
224     SL::DB::CustomVariableValidity->new(config_id => $self->config->id, trans_id => $part->id)->save;
225   }
226 }
227
228 1;