1 package SL::Controller::SimpleSystemSetting;
6 use parent qw(SL::Controller::Base);
9 use SL::Locale::String;
11 use SL::System::Process;
13 use Rose::Object::MakeMethods::Generic (
14 scalar => [ qw(type config) ],
15 'scalar --get_set_init' => [ qw(defaults object all_objects class manager_class list_attributes list_url supports_reordering) ],
18 __PACKAGE__->run_before('check_type_and_auth');
19 __PACKAGE__->run_before('setup_javascript', only => [ qw(add create edit update delete) ]);
21 # Make locales.pl happy: $self->render("simple_system_setting/_default_form")
23 my %supported_types = (
25 # Make locales.pl happy: $self->render("simple_system_setting/_bank_account_form")
26 class => 'BankAccount',
28 list => t8('Bank accounts'),
29 add => t8('Add bank account'),
30 edit => t8('Edit bank account'),
33 { method => 'name', title => t8('Name'), },
34 { method => 'iban', title => t8('IBAN'), },
35 { method => 'bank', title => t8('Bank'), },
36 { method => 'bank_code', title => t8('Bank code'), },
37 { method => 'bic', title => t8('BIC'), },
38 { method => 'reconciliation_starting_date_as_date', title => t8('Date'), align => 'right' },
39 { method => 'reconciliation_starting_balance_as_number', title => t8('Balance'), align => 'right' },
44 # Make locales.pl happy: $self->render("simple_system_setting/_business_form")
47 list => t8('Businesses'),
48 add => t8('Add business'),
49 edit => t8('Edit business'),
52 { method => 'description', title => t8('Description'), },
53 { title => t8('Discount'), formatter => sub { $_[0]->discount_as_percent . ' %' }, align => 'right' },
54 { method => 'customernumberinit', title => t8('Customernumberinit'), },
59 class => 'Department',
61 list => t8('Departments'),
62 add => t8('Add department'),
63 edit => t8('Edit department'),
68 # Make locales.pl happy: $self->render("simple_system_setting/_language_form")
71 list => t8('Languages'),
72 add => t8('Add language'),
73 edit => t8('Edit language'),
76 { method => 'description', title => t8('Description'), },
77 { method => 'template_code', title => t8('Template Code'), },
78 { method => 'article_code', title => t8('Article Code'), },
79 { title => t8('Number Format'), formatter => sub { $_[0]->output_numberformat || t8('use program settings') } },
80 { title => t8('Date Format'), formatter => sub { $_[0]->output_dateformat || t8('use program settings') } },
81 { title => t8('Long Dates'), formatter => sub { $_[0]->output_longdates ? t8('yes') : t8('no') } },
85 part_classification => {
86 # Make locales.pl happy: $self->render("simple_system_setting/_part_classification_form")
87 class => 'PartClassification',
89 list => t8('Part classifications'),
90 add => t8('Add part classification'),
91 edit => t8('Edit part classification'),
94 { title => t8('Description'), formatter => sub { t8($_[0]->description) } },
95 { title => t8('Type abbreviation'), formatter => sub { t8($_[0]->abbreviation) } },
96 { title => t8('Used for Purchase'), formatter => sub { $_[0]->used_for_purchase ? t8('yes') : t8('no') } },
97 { title => t8('Used for Sale'), formatter => sub { $_[0]->used_for_sale ? t8('yes') : t8('no') } },
98 { title => t8('Report separately'), formatter => sub { $_[0]->report_separate ? t8('yes') : t8('no') } },
103 # Make locales.pl happy: $self->render("simple_system_setting/_parts_group_form")
104 class => 'PartsGroup',
106 list => t8('Partsgroups'),
107 add => t8('Add partsgroup'),
108 edit => t8('Edit partsgroup'),
111 { method => 'partsgroup', title => t8('Description') },
112 { method => 'obsolete', title => t8('Obsolete'), formatter => sub { $_[0]->obsolete ? t8('yes') : t8('no') } },
117 # Make locales.pl happy: $self->render("simple_system_setting/_price_factor_form")
118 class => 'PriceFactor',
120 list => t8('Price Factors'),
121 add => t8('Add Price Factor'),
122 edit => t8('Edit Price Factor'),
125 { method => 'description', title => t8('Description') },
126 { method => 'factor_as_number', title => t8('Factor'), align => 'right' },
131 # Make locales.pl happy: $self->render("simple_system_setting/_pricegroup_form")
132 class => 'Pricegroup',
134 list => t8('Pricegroups'),
135 add => t8('Add pricegroup'),
136 edit => t8('Edit pricegroup'),
139 { method => 'pricegroup', title => t8('Description') },
140 { method => 'obsolete', title => t8('Obsolete'), formatter => sub { $_[0]->obsolete ? t8('yes') : t8('no') } },
145 class => 'ProjectStatus',
147 list => t8('Project statuses'),
148 add => t8('Add project status'),
149 edit => t8('Edit project status'),
154 class => 'ProjectType',
156 list => t8('Project types'),
157 add => t8('Add project type'),
158 edit => t8('Edit project type'),
162 requirement_spec_acceptance_status => {
163 # Make locales.pl happy: $self->render("simple_system_setting/_requirement_spec_acceptance_status_form")
164 class => 'RequirementSpecAcceptanceStatus',
166 list => t8('Acceptance Statuses'),
167 add => t8('Add acceptance status'),
168 edit => t8('Edit acceptance status'),
171 { method => 'name', title => t8('Name') },
172 { method => 'description', title => t8('Description') },
176 requirement_spec_complexity => {
177 class => 'RequirementSpecComplexity',
179 list => t8('Complexities'),
180 add => t8('Add complexity'),
181 edit => t8('Edit complexity'),
185 requirement_spec_predefined_text => {
186 # Make locales.pl happy: $self->render("simple_system_setting/_requirement_spec_predefined_text_form")
187 class => 'RequirementSpecPredefinedText',
189 list => t8('Pre-defined Texts'),
190 add => t8('Add pre-defined text'),
191 edit => t8('Edit pre-defined text'),
194 { method => 'description', title => t8('Description') },
195 { method => 'title', title => t8('Title') },
196 { title => t8('Content'), formatter => sub { my $t = $_[0]->text_as_stripped_html; length($t) > 50 ? substr($t, 0, 50) . '…' : $t } },
197 { title => t8('Useable for text blocks'), formatter => sub { $_[0]->useable_for_text_blocks ? t8('yes') : t8('no') } },
198 { title => t8('Useable for sections'), formatter => sub { $_[0]->useable_for_sections ? t8('yes') : t8('no') } },
202 requirement_spec_risk => {
203 class => 'RequirementSpecRisk',
205 list => t8('Risk levels'),
206 add => t8('Add risk level'),
207 edit => t8('Edit risk level'),
211 requirement_spec_status => {
212 # Make locales.pl happy: $self->render("simple_system_setting/_requirement_spec_status_form")
213 class => 'RequirementSpecStatus',
215 list => t8('Requirement Spec Statuses'),
216 add => t8('Add requirement spec status'),
217 edit => t8('Edit requirement spec status'),
220 { method => 'name', title => t8('Name') },
221 { method => 'description', title => t8('Description') },
225 requirement_spec_type => {
226 # Make locales.pl happy: $self->render("simple_system_setting/_requirement_spec_type_form")
227 class => 'RequirementSpecType',
229 list => t8('Requirement Spec Types'),
230 add => t8('Add requirement spec type'),
231 edit => t8('Edit requirement spec type'),
234 { method => 'description', title => t8('Description') },
235 { method => 'section_number_format', title => t8('Section number format') },
236 { method => 'function_block_number_format', title => t8('Function block number format') },
242 my @default_list_attributes = (
243 { method => 'description', title => t8('Description') },
253 $self->setup_list_action_bar;
254 $self->render('simple_system_setting/list', title => $self->config->{titles}->{list});
260 $self->object($self->class->new);
261 $self->render_form(title => $self->config->{titles}->{add});
267 $self->render_form(title => $self->config->{titles}->{edit});
273 $self->object($self->class->new);
274 $self->create_or_update;
280 $self->create_or_update;
286 if ($self->object->can('orphaned') && !$self->object->orphaned) {
287 flash_later('error', t8('The object is in use and cannot be deleted.'));
289 } elsif ( eval { $self->object->delete; 1; } ) {
290 flash_later('info', t8('The object has been deleted.'));
293 flash_later('error', t8('The object is in use and cannot be deleted.'));
296 $self->redirect_to($self->list_url);
302 $self->class->reorder_list(@{ $::form->{object_id} || [] });
303 $self->render(\'', { type => 'json' });
310 sub check_type_and_auth {
313 $self->type($::form->{type});
314 $self->config($supported_types{$self->type}) || die "Unsupported type";
316 $::auth->assert($self->config->{auth} || 'config');
318 my $pm = (map { s{::}{/}g; "${_}.pm" } $self->class)[0];
321 my $setup = "setup_" . $self->type;
322 $self->$setup if $self->can($setup);
327 sub setup_javascript {
328 $::request->layout->use_javascript("${_}.js") for qw(ckeditor/ckeditor ckeditor/adapters/jquery);
331 sub init_class { "SL::DB::" . $_[0]->config->{class} }
332 sub init_manager_class { "SL::DB::Manager::" . $_[0]->config->{class} }
333 sub init_object { $_[0]->class->new(id => $::form->{id})->load }
334 sub init_all_objects { $_[0]->manager_class->get_all_sorted }
335 sub init_list_url { $_[0]->url_for(action => 'list', type => $_[0]->type) }
336 sub init_supports_reordering { $_[0]->class->new->can('reorder_list') }
337 sub init_defaults { SL::DB::Default->get }
339 sub init_list_attributes {
342 my $method = "list_attributes_" . $self->type;
344 return $self->$method if $self->can($method);
345 return $self->config->{list_attributes} // \@default_list_attributes;
352 sub create_or_update {
354 my $is_new = !$self->object->id;
356 my $params = delete($::form->{object}) || { };
358 $self->object->assign_attributes(%{ $params });
362 push @errors, $self->object->validate if $self->object->can('validate');
365 flash('error', @errors);
366 return $self->render_form(title => $self->config->{titles}->{$is_new ? 'add' : 'edit'});
371 flash_later('info', $is_new ? t8('The object has been created.') : t8('The object has been saved.'));
373 $self->redirect_to($self->list_url);
377 my ($self, %params) = @_;
379 my $sub_form_template = SL::System::Process->exe_dir . '/templates/webpages/simple_system_setting/_' . $self->type . '_form.html';
381 $self->setup_render_form_action_bar;
383 'simple_system_setting/form',
385 sub_form_template => (-f $sub_form_template ? $self->type : 'default'),
390 # type-specific helper functions
393 sub setup_requirement_spec_acceptance_status {
397 $self->{valid_names} = \@SL::DB::RequirementSpecAcceptanceStatus::valid_names;
400 sub setup_requirement_spec_status {
404 $self->{valid_names} = \@SL::DB::RequirementSpecStatus::valid_names;
410 $self->{numberformats} = [ '1,000.00', '1000.00', '1.000,00', '1000,00', "1'000.00" ];
411 $self->{dateformats} = [ qw(mm/dd/yy dd/mm/yy dd.mm.yy yyyy-mm-dd) ];
418 sub setup_list_action_bar {
419 my ($self, %params) = @_;
421 for my $bar ($::request->layout->get('actionbar')) {
425 link => $self->url_for(action => 'new', type => $self->type),
431 sub setup_render_form_action_bar {
434 my $is_new = !$self->object->id;
435 my $can_be_deleted = !$is_new
436 && (!$self->object->can("orphaned") || $self->object->orphaned)
437 && (!$self->object->can("can_be_deleted") || $self->object->can_be_deleted);
439 for my $bar ($::request->layout->get('actionbar')) {
443 submit => [ '#form', { action => 'SimpleSystemSetting/' . ($is_new ? 'create' : 'update') } ],
444 checks => [ 'kivi.validate_form' ],
445 accesskey => 'enter',
450 submit => [ '#form', { action => 'SimpleSystemSetting/delete' } ],
451 confirm => t8('Do you really want to delete this object?'),
452 disabled => $is_new ? t8('This object has not been saved yet.')
453 : !$can_be_deleted ? t8('The object is in use and cannot be deleted.')
459 link => $self->list_url,
463 $::request->layout->add_javascripts('kivi.Validator.js');
474 SL::Controller::SimpleSystemSettings — a common CRUD controller for
475 various settings in the "System" menu
479 Moritz Bunkus <m.bunkus@linet-services.de>