1 package SL::DB::Helper::CustomVariables;
6 use List::Util qw(first);
8 use constant META_CVARS => 'cvars_config';
11 my ($class, %params) = @_;
12 my $caller_package = caller;
14 # TODO: if module is empty, module overloading needs to take effect
15 # certain stuff may have more than one overload, odr even more than one type
16 defined $caller_package or croak 'need to be included from a caller reference';
18 $params{module} ||= _calc_modules_from_overloads(%params) if $params{overloads};
19 $params{sub_module} ||= '';
20 $params{id} ||= _get_primary_key_column($caller_package);
22 $params{module} || $params{sub_module} or croak 'need param module or sub_module';
24 return unless save_meta_info($caller_package, %params);
25 make_cvar_accessor($caller_package, %params);
26 make_cvar_alias($caller_package, %params) if $params{cvars_alias};
27 make_cvar_by_configs($caller_package, %params);
28 make_cvar_by_name($caller_package, %params);
29 make_cvar_as_hashref($caller_package, %params);
30 make_cvar_value_parser($caller_package, %params);
31 make_cvar_custom_filter($caller_package, %params);
35 my ($caller_package, %params) = @_;
37 my $meta = $caller_package->meta;
38 return 0 if $meta->{META_CVARS()};
40 $meta->{META_CVARS()} = \%params;
45 sub make_cvar_accessor {
46 my ($caller_package, %params) = @_;
48 my $modules = ('ARRAY' eq ref $params{module}) ?
49 join ',', @{ $params{module} } :
51 my @module_filter = $modules ?
52 ("config_id" => [ \"(SELECT custom_variable_configs.id FROM custom_variable_configs WHERE custom_variable_configs.module IN ( '$modules' ))" ]) : # " make emacs happy
55 $caller_package->meta->add_relationships(
57 type => 'one to many',
58 class => 'SL::DB::CustomVariable',
59 column_map => { $params{id} => 'trans_id' },
60 query_args => [ sub_module => $params{sub_module}, @module_filter ],
66 my ($caller_package) = @_;
68 *{ $caller_package . '::cvars' } = sub {
69 goto &{ $caller_package . '::custom_variables' };
73 # this is used for templates where you need to list every applicable config
74 # auto vivifies non existent cvar objects as necessary.
75 sub make_cvar_by_configs {
76 my ($caller_package, %params) = @_;
79 *{ $caller_package . '::cvars_by_config' } = sub {
81 @_ > 1 and croak "not an accessor";
83 my $configs = _all_configs(%params);
84 my $cvars = $self->custom_variables;
85 my %cvars_by_config = map { $_->config_id => $_ } @$cvars;
89 if ( $cvars_by_config{$_->id} ) {
90 $cvars_by_config{$_->id};
93 my $cvar = _new_cvar($self, %params, config => $_);
94 $self->add_custom_variables($cvar);
105 # this is used for print templates where you need to refer to a variable by name
106 # TODO typically these were referred as prefix_'cvar'_name
107 sub make_cvar_by_name {
108 my ($caller_package, %params) = @_;
111 *{ $caller_package . '::cvar_by_name' } = sub {
112 my ($self, $name) = @_;
114 my $configs = _all_configs(%params);
115 my $cvars = $self->custom_variables;
116 my $config = first { $_->name eq $name } @$configs;
118 croak "unknown cvar name $name" unless $config;
120 my $cvar = first { $_->config_id eq $config->id } @$cvars;
123 $cvar = _new_cvar($self, %params, config => $config);
124 $self->add_custom_variables($cvar);
131 sub make_cvar_as_hashref {
132 my ($caller_package, %params) = @_;
135 *{ $caller_package . '::cvar_as_hashref' } = sub {
137 @_ > 1 and croak "not an accessor";
139 my $cvars_by_config = $self->cvars_by_config;
142 $_->config->name => { value => $_->value_as_text, is_valid => $_->is_valid }
149 sub make_cvar_value_parser {
150 my ($caller_package) = @_;
152 *{ $caller_package . '::parse_custom_variable_values' } = sub {
155 $_->parse_value for @{ $self->custom_variables || [] };
160 $caller_package->before_save('parse_custom_variable_values');
166 require SL::DB::CustomVariableConfig;
168 SL::DB::Manager::CustomVariableConfig->get_all_sorted($params{module} ? (query => [ module => $params{module} ]) : ());
171 sub _overload_by_module {
172 my ($module, %params) = @_;
174 keys %{ $params{overloads} }; # reset each iterator
175 while (my ($fk, $def) = each %{ $params{overloads} }) {
176 return ($fk, $def->{class}) if $def->{module} eq $module;
179 croak "unknown overload, cannot resolve module $module";
183 my ($self, %params) = @_;
185 # check overloading first
186 if ($params{sub_module}) {
187 my ($fk, $class) = _overload_by_module($params{config}->module, %params);
188 my $base_cvar = $class->new(id => $self->$fk)->load->cvar_by_name($params{config}->name);
189 $inherited_value = $base_cvar->value;
192 my $cvar = SL::DB::CustomVariable->new(
193 config => $params{config},
194 trans_id => $self->${ \ $params{id} },
195 sub_module => $params{sub_module},
199 ? $cvar->value($inherited_value)
200 : $cvar->value($params{config}->type_dependent_default_value);
204 sub _calc_modules_from_overloads {
208 for my $def (values %{ $params{overloads} || {} }) {
209 $modules{$def->{module}} = 1;
212 return [ keys %modules ];
215 sub _get_primary_key_column {
216 my ($caller_package) = @_;
217 my $meta = $caller_package->meta;
220 $column_name = $meta->{primary_key}->{columns}->[0] if $meta->{primary_key} && (ref($meta->{primary_key}->{columns}) eq 'ARRAY') && (1 == scalar(@{ $meta->{primary_key}->{columns} }));
222 croak "Unable to retrieve primary key column name: meta information for package $caller_package not set up correctly" unless $column_name;
227 sub make_cvar_custom_filter {
228 my ($caller_package, %params) = @_;
230 my $manager = $caller_package->meta->convention_manager->auto_manager_class_name;
232 return unless $manager->can('filter');
234 $manager->add_filter_specs(
236 my ($key, $value, $prefix, $config_id) = @_;
237 my $config = SL::DB::Manager::CustomVariableConfig->find_by(id => $config_id);
240 die "invalid config_id in $caller_package\::cvar custom filter: $config_id";
243 if ($config->module != $params{module}) {
244 die "invalid config_id in $caller_package\::cvar custom filter: expected module $params{module} - got @{[ $config->module ]}";
247 my (%query, %bind_vals);
248 ($query{customized}, $bind_vals{customized}) = Rose::DB::Object::QueryBuilder::build_select(
250 select => 'trans_id',
251 tables => [ 'custom_variables' ],
252 columns => { custom_variables => [ qw(trans_id config_id text_value number_value bool_value timestamp_value sub_module) ] },
254 config_id => $config_id,
255 sub_module => $params{sub_module},
256 $config->value_col => $value,
261 my $conversion = $config->type =~ m{^(?:date|timestamp)$} ? $config->type
262 : $config->type =~ m{^(?:customer|vendor|part)$} ? 'integer'
263 : $config->type eq 'bool' ? 'boolean'
264 : $config->type eq 'number' ? 'numeric'
267 ($query{config}, $bind_vals{config}) = Rose::DB::Object::QueryBuilder::build_select(
270 tables => [ 'custom_variable_configs' ],
271 columns => { custom_variable_configs => [ qw(id default_value) ] },
274 default_value => $value,
279 $query{config} =~ s{\bdefault_value\b}{default_value::${conversion}} if $conversion;
281 ($query{not_customized}, $bind_vals{not_customized}) = Rose::DB::Object::QueryBuilder::build_select(
283 select => 'trans_id',
284 tables => [ 'custom_variables' ],
285 columns => { custom_variables => [ qw(trans_id config_id sub_module) ] },
287 config_id => $config_id,
288 sub_module => $params{sub_module},
293 foreach my $key (keys %query) {
294 # remove rose aliases. query builder sadly is not reentrant, and will reuse the same aliases. :(
295 $query{$key} =~ s{\bt\d+(?:\.)?\b}{}g;
297 # manually inline the values. again, rose doen't know how to handly bind params in subqueries :(
298 $query{$key} =~ s{\?}{ $config->dbh->quote($_) }xe for @{ $bind_vals{$key} };
300 $query{$key} =~ s{\n}{ }g;
303 my $qry_config = "EXISTS (" . $query{config} . ")";
307 $prefix . 'id' => [ \$query{customized} ],
309 "!${prefix}id" => [ \$query{not_customized} ],
328 SL::DB::Helper::CustomVariables - Mixin to provide custom variables relations
332 # use in a primary class
333 use SL::DB::Helper::CustomVariables (
338 # use overloading in a secondary class
339 use SL::DB::Helper::CustomVariables (
340 sub_module => 'orderitems',
344 class => 'SL::DB::Part',
352 This module provides methods to deal with named custom variables. Two concepts are understood.
354 =head2 Primary CVar Classes
356 Primary classes are those that feature cvars for themselves. Currently those
357 are Part, Contact, Customer and Vendor. cvars for these will get saved directly
360 =head2 Secondary CVar Classes
362 Secondary classes inherit their cvars from member relationships. This is built
363 so that orders can save a copy of the cvars of their parts, customers and the
364 like to be immutable later on.
366 Secondary classes may currently not have cvars of their own.
368 =head1 INSTALLED METHODS
372 =item C<custom_variables [ CUSTOM_VARIABLES ]>
374 This is a Rose::DB::Object::Relationship accessor, generated for cvars. Use it
375 like any other OneToMany relationship.
377 Note that unlike L</cvars_by_config> this accessor only returns
378 variables that have already been created for this object. No variables
379 will be autovivified for configs for which no variable has been
382 =item C<cvars [ CUSTOM_VARIABLES ]>
384 Alias to C<custom_variables>. Will only be installed if C<cvars_alias> was
387 =item C<cvars_by_config>
389 Thi will return a list of CVars with the following changes over the standard accessor:
395 The list will be returned in the sorted order of the configs.
399 For every config exactly one CVar will be returned.
403 If no cvar was found for a config, a new one will be vivified, set to the
404 correct config, module etc, and registered into the object.
408 Vivified cvars for secondary classes will first try to find their base object
409 and use that value. If no such value or cvar is found the default value from
414 This is useful if you need to list every possible CVar, like in CRUD masks.
416 =item C<cvar_by_name NAME [ VALUE ]>
418 Returns the CVar object for this object which matches the given internal name.
419 Useful for print templates. If the requested cvar is not present, it will be
420 vivified with the same rules as in C<cvars_by_config>.
422 =item C<parse_custom_variable_values>
424 When you want to edit custom variables in a form then you have
425 unparsed values from the user. These should be written to the
426 variable's C<unparsed_value> field.
428 This function then processes all variables and parses their
429 C<unparsed_value> field into the proper field. It returns C<$self> for
432 This is automatically called in a C<before_save> hook so you don't
433 have to do it manually if you save directly after assigning the
436 In an HTML form you could e.g. use something like the following:
438 [%- FOREACH var = SELF.project.cvars_by_config.as_list %]
439 [% HTML.escape(var.config.description) %]:
440 [% L.hidden_tag('project.custom_variables[+].config_id', var.config.id) %]
441 [% PROCESS 'common/render_cvar_input.html' var_name='project.custom_variables[].unparsed_value' %]
444 Later in the controller when you want to save this project you don't
445 have to do anything special:
447 my $project = SL::DB::Project->new;
448 my $params = $::form->{project} || {};
450 $project->assign_attributes(%{ $params });
452 $project->parse_custom_variable_values->save;
454 However, if you need access to a variable's value before saving in
455 some way then you have to call this function manually. For example:
457 my $project = SL::DB::Project->new;
458 my $params = $::form->{project} || {};
460 $project->assign_attributes(%{ $params });
462 $project->parse_custom_variable_values;
464 print STDERR "CVar[0] value: " . $project->custom_variables->[0]->value . "\n";
468 =head1 INSTALLED MANAGER METHODS
472 =item Custom filter for GetModels
474 If the Manager for the calling C<SL::DB::Object> has included the helper L<SL::DB::Helper::Filtered>, a custom filter for cvars will be added to the specs, with the following syntax:
476 filter.cvar.$config_id
482 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>,
483 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>