5 use List::Util qw(first);
9 use SL::MoreCommon qw(listify);
12 $main::lxdebug->enter_sub();
17 my $myconfig = \%main::myconfig;
18 my $form = $main::form;
20 my $dbh = $params{dbh} || $form->get_standard_dbh($myconfig);
23 if ($params{module}) {
24 $where = 'WHERE module = ?';
25 push @values, $params{module};
28 my $query = qq|SELECT * FROM custom_variable_configs $where ORDER BY sortkey|;
30 my $configs = selectall_hashref_query($form, $dbh, $query, @values);
32 foreach my $config (@{ $configs }) {
33 if ($config->{type} eq 'select') {
34 $config->{OPTIONS} = [ map { { 'value' => $_ } } split(m/\#\#/, $config->{options}) ];
36 } elsif ($config->{type} eq 'number') {
37 $config->{precision} = $1 if ($config->{options} =~ m/precision=(\d+)/i);
41 $self->_unpack_flags($config);
44 $main::lxdebug->leave_sub();
50 $main::lxdebug->enter_sub();
55 Common::check_params(\%params, qw(id));
57 my $myconfig = \%main::myconfig;
58 my $form = $main::form;
60 my $dbh = $params{dbh} || $form->get_standard_dbh($myconfig);
62 my $query = qq|SELECT * FROM custom_variable_configs WHERE id = ?|;
64 my $config = selectfirst_hashref_query($form, $dbh, $query, conv_i($params{id})) || { };
66 $self->_unpack_flags($config);
68 $main::lxdebug->leave_sub();
74 $main::lxdebug->enter_sub();
79 foreach my $flag (split m/:/, $config->{flags}) {
80 if ($flag =~ m/(.*?)=(.*)/) {
81 $config->{"flag_${1}"} = $2;
83 $config->{"flag_${flag}"} = 1;
87 $main::lxdebug->leave_sub();
91 $main::lxdebug->enter_sub();
96 Common::check_params(\%params, qw(module config));
98 my $myconfig = \%main::myconfig;
99 my $form = $main::form;
101 my $dbh = $params{dbh} || $form->get_standard_dbh($myconfig);
103 my $q_id = qq|SELECT nextval('custom_variable_configs_id')|;
104 my $h_id = prepare_query($form, $dbh, $q_id);
107 qq|INSERT INTO custom_variable_configs (name, description, type, default_value, options, searchable, includeable, included_by_default, module, flags, id, sortkey)
108 VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?,
109 (SELECT COALESCE(MAX(sortkey) + 1, 1) FROM custom_variable_configs))|;
110 my $h_new = prepare_query($form, $dbh, $q_new);
113 qq|UPDATE custom_variable_configs SET
114 name = ?, description = ?,
115 type = ?, default_value = ?,
116 options = ?, searchable = ?,
117 includeable = ?, included_by_default = ?,
118 module = ?, flags = ?
120 my $h_update = prepare_query($form, $dbh, $q_update);
123 if ('ARRAY' eq ref $params{config}) {
124 @configs = @{ $params{config} };
126 @configs = ($params{config});
129 foreach my $config (@configs) {
130 my ($h_actual, $q_actual);
132 if (!$config->{id}) {
133 do_statement($form, $h_id, $q_id);
134 ($config->{id}) = $h_id->fetchrow_array();
140 $h_actual = $h_update;
141 $q_actual = $q_update;
144 do_statement($form, $h_actual, $q_actual, @{$config}{qw(name description type default_value options)},
145 $config->{searchable} ? 't' : 'f', $config->{includeable} ? 't' : 'f', $config->{included_by_default} ? 't' : 'f',
146 $params{module}, $config->{flags}, conv_i($config->{id}));
155 $main::lxdebug->leave_sub();
159 $main::lxdebug->enter_sub();
164 Common::check_params(\%params, qw(id));
166 my $myconfig = \%main::myconfig;
167 my $form = $main::form;
169 my $dbh = $params{dbh} || $form->get_standard_dbh($myconfig);
171 do_query($form, $dbh, qq|DELETE FROM custom_variables WHERE config_id = ?|, conv_i($params{id}));
172 do_query($form, $dbh, qq|DELETE FROM custom_variable_configs WHERE id = ?|, conv_i($params{id}));
176 $main::lxdebug->leave_sub();
179 sub get_custom_variables {
180 $main::lxdebug->enter_sub();
185 Common::check_params(\%params, qw(module));
187 my $myconfig = \%main::myconfig;
188 my $form = $main::form;
190 my $dbh = $params{dbh} || $form->get_standard_dbh($myconfig);
192 my $trans_id = $params{trans_id} ? 'OR (v.trans_id = ?) ' : '';
195 qq|SELECT id, name, description, type, default_value, options,
196 date_trunc('seconds', localtimestamp) AS current_timestamp, current_date AS current_date
197 FROM custom_variable_configs
202 qq|SELECT text_value, timestamp_value, timestamp_value::date AS date_value, number_value, bool_value
203 FROM custom_variables
204 WHERE (config_id = ?) AND (trans_id = ?)|;
205 $q_var .= qq| AND (sub_module = ?)| if $params{sub_module};
206 my $h_var = prepare_query($form, $dbh, $q_var);
208 my $custom_variables = selectall_hashref_query($form, $dbh, $q_cfg, $params{module});
210 foreach my $cvar (@{ $custom_variables }) {
211 if ($cvar->{type} eq 'textfield') {
215 $cvar->{width} = $1 if ($cvar->{options} =~ m/width=(\d+)/i);
216 $cvar->{height} = $1 if ($cvar->{options} =~ m/height=(\d+)/i);
218 } elsif ($cvar->{type} eq 'text') {
219 $cvar->{maxlength} = $1 if ($cvar->{options} =~ m/maxlength=(\d+)/i);
221 } elsif ($cvar->{type} eq 'number') {
222 $cvar->{precision} = $1 if ($cvar->{options} =~ m/precision=(\d+)/i);
224 } elsif ($cvar->{type} eq 'select') {
225 $cvar->{OPTIONS} = [ map { { 'value' => $_ } } split(m/\#\#/, $cvar->{options}) ];
229 if ($params{trans_id}) {
230 my @values = (conv_i($cvar->{id}), conv_i($params{trans_id}));
231 push @values, $params{sub_module} if $params{sub_module};
233 do_statement($form, $h_var, $q_var, @values);
234 $act_var = $h_var->fetchrow_hashref();
236 $act_var->{valid} = $self->get_custom_variables_validity(config_id => $cvar->{id}, trans_id => $params{trans_id});
240 $cvar->{value} = $cvar->{type} eq 'date' ? $act_var->{date_value}
241 : $cvar->{type} eq 'timestamp' ? $act_var->{timestamp_value}
242 : $cvar->{type} eq 'number' ? $act_var->{number_value}
243 : $cvar->{type} eq 'bool' ? $act_var->{bool_value}
244 : $act_var->{text_value};
245 $cvar->{valid} = $act_var->{valid};
247 if ($cvar->{type} eq 'date') {
248 if ($cvar->{default_value} eq 'NOW') {
249 $cvar->{value} = $cvar->{current_date};
251 $cvar->{value} = $cvar->{default_value};
254 } elsif ($cvar->{type} eq 'timestamp') {
255 if ($cvar->{default_value} eq 'NOW') {
256 $cvar->{value} = $cvar->{current_timestamp};
258 $cvar->{value} = $cvar->{default_value};
261 } elsif ($cvar->{type} eq 'bool') {
262 $cvar->{value} = $cvar->{default_value} * 1;
264 } elsif ($cvar->{type} eq 'number') {
265 $cvar->{value} = $cvar->{default_value} * 1 if ($cvar->{default_value} ne '');
268 $cvar->{value} = $cvar->{default_value};
272 if ($cvar->{type} eq 'number') {
273 $cvar->{value} = $form->format_amount($myconfig, $cvar->{value} * 1, $cvar->{precision});
279 $main::lxdebug->leave_sub();
281 return $custom_variables;
284 sub save_custom_variables {
285 $main::lxdebug->enter_sub();
290 Common::check_params(\%params, qw(module trans_id variables));
292 my $myconfig = \%main::myconfig;
293 my $form = $main::form;
295 my $dbh = $params{dbh} || $form->get_standard_dbh($myconfig);
297 my @configs = $params{configs} ? @{ $params{configs} } : grep { $_->{module} eq $params{module} } @{ CVar->get_configs() };
300 qq|DELETE FROM custom_variables
302 AND (config_id IN (SELECT DISTINCT id
303 FROM custom_variable_configs
305 my @values = (conv_i($params{trans_id}), $params{module});
307 if ($params{sub_module}) {
308 $query .= qq| AND (sub_module = ?)|;
309 push @values, $params{sub_module};
312 do_query($form, $dbh, $query, @values);
315 qq|INSERT INTO custom_variables (config_id, sub_module, trans_id, bool_value, timestamp_value, text_value, number_value)
316 VALUES (?, ?, ?, ?, ?, ?, ?)|;
317 my $sth = prepare_query($form, $dbh, $query);
319 foreach my $config (@configs) {
320 my @values = (conv_i($config->{id}), "$params{sub_module}", conv_i($params{trans_id}));
322 my $value = $params{variables}->{"$params{name_prefix}cvar_$config->{name}$params{name_postfix}"};
324 if (($config->{type} eq 'text') || ($config->{type} eq 'textfield') || ($config->{type} eq 'select')) {
325 push @values, undef, undef, $value, undef;
327 } elsif (($config->{type} eq 'date') || ($config->{type} eq 'timestamp')) {
328 push @values, undef, conv_date($value), undef, undef;
330 } elsif ($config->{type} eq 'number') {
331 push @values, undef, undef, undef, conv_i($form->parse_amount($myconfig, $value));
333 } elsif ($config->{type} eq 'bool') {
334 push @values, $value ? 't' : 'f', undef, undef, undef;
337 do_statement($form, $sth, $query, @values);
339 unless ($params{always_valid}) {
340 $self->save_custom_variables_validity(trans_id => $params{trans_id}, config_id => $config->{id},
341 validity => ($params{variables}->{"$params{name_prefix}cvar_$config->{name}$params{name_postfix}_valid"} ? 1 : 0)
350 $main::lxdebug->leave_sub();
354 $main::lxdebug->enter_sub();
359 Common::check_params(\%params, qw(variables));
361 my $myconfig = \%main::myconfig;
362 my $form = $main::form;
364 my %options = ( name_prefix => "$params{name_prefix}",
365 name_postfix => "$params{name_postfix}",
366 hide_non_editable => $params{hide_non_editable},
367 show_disabled_message => $params{show_disabled_message},
370 foreach my $var (@{ $params{variables} }) {
371 $var->{HTML_CODE} = $form->parse_html_template('amcvar/render_inputs', { var => $var, %options });
372 $var->{VALID_BOX} = $form->parse_html_template('amcvar/render_checkboxes', { var => $var, %options });
375 $main::lxdebug->leave_sub();
378 sub render_search_options {
379 $main::lxdebug->enter_sub();
384 Common::check_params(\%params, qw(variables));
386 my $myconfig = \%main::myconfig;
387 my $form = $main::form;
389 $params{include_prefix} = 'l_' unless defined($params{include_prefix});
390 $params{include_value} ||= '1';
392 my $filter = $form->parse_html_template('amcvar/search_filter', \%params);
393 my $include = $form->parse_html_template('amcvar/search_include', \%params);
395 $main::lxdebug->leave_sub();
397 return ($filter, $include);
400 sub build_filter_query {
401 $main::lxdebug->enter_sub();
406 Common::check_params(\%params, qw(module trans_id_field filter));
408 my $myconfig = \%main::myconfig;
409 my $form = $main::form;
411 my $dbh = $params{dbh} || $form->get_standard_dbh($myconfig);
413 my $configs = $self->get_configs(%params);
415 my (@where, @values);
417 foreach my $config (@{ $configs }) {
418 next unless ($config->{searchable});
420 my $name = "cvar_$config->{name}";
422 my (@sub_values, @sub_where, $not);
424 if (($config->{type} eq 'text') || ($config->{type} eq 'textfield')) {
425 next unless ($params{filter}->{$name});
427 push @sub_where, qq|cvar.text_value ILIKE ?|;
428 push @sub_values, '%' . $params{filter}->{$name} . '%'
430 } elsif ($config->{type} eq 'select') {
431 next unless ($params{filter}->{$name});
433 push @sub_where, qq|cvar.text_value = ?|;
434 push @sub_values, $params{filter}->{$name};
436 } elsif (($config->{type} eq 'date') || ($config->{type} eq 'timestamp')) {
437 my $name_from = "${name}_from";
438 my $name_to = "${name}_to";
440 if ($params{filter}->{$name_from}) {
441 push @sub_where, qq|cvar.timestamp_value >= ?|;
442 push @sub_values, conv_date($params{filter}->{$name_from});
445 if ($params{filter}->{$name_to}) {
446 push @sub_where, qq|cvar.timestamp_value <= ?|;
447 push @sub_values, conv_date($params{filter}->{$name_to});
450 } elsif ($config->{type} eq 'number') {
451 next if ($params{filter}->{$name} eq '');
453 my $f_op = $params{filter}->{"${name}_qtyop"};
459 } elsif ($f_op eq '=/=') {
463 } elsif ($f_op eq '<') {
467 } elsif ($f_op eq '<=') {
471 } elsif (($f_op eq '>') || ($f_op eq '>=')) {
478 push @sub_where, qq|cvar.number_value $op ?|;
479 push @sub_values, $form->parse_amount($myconfig, $params{filter}->{$name});
481 } elsif ($config->{type} eq 'bool') {
482 next unless ($params{filter}->{$name});
484 $not = 'NOT' if ($params{filter}->{$name} eq 'no');
485 push @sub_where, qq|COALESCE(cvar.bool_value, false) = TRUE|;
489 push @sub_where, qq|cvar.sub_module = ?|;
490 push @sub_values, "$params{sub_module}";
495 FROM custom_variables cvar
496 LEFT JOIN custom_variable_configs cvarcfg ON (cvar.config_id = cvarcfg.id)
497 WHERE (cvarcfg.module = ?)
499 AND (cvar.trans_id = $params{trans_id_field})
500 AND | . join(' AND ', map { "($_)" } @sub_where) . qq|)|;
501 push @values, $params{module}, conv_i($config->{id}), @sub_values;
505 my $query = join ' AND ', @where;
507 $main::lxdebug->leave_sub();
509 return ($query, @values);
512 sub add_custom_variables_to_report {
513 $main::lxdebug->enter_sub();
518 Common::check_params(\%params, qw(module trans_id_field column_defs data configs));
520 my $myconfig = \%main::myconfig;
521 my $form = $main::form;
522 my $locale = $main::locale;
524 my $dbh = $params{dbh} || $form->get_standard_dbh($myconfig);
526 my $configs = [ grep { $_->{includeable} && $params{column_defs}->{"cvar_$_->{name}"}->{visible} } @{ $params{configs} } ];
528 if (!scalar(@{ $params{data} }) || ! scalar(@{ $configs })) {
529 $main::lxdebug->leave_sub();
533 # allow sub_module to be a coderef or a fixed value
534 if (ref $params{sub_module} ne 'CODE') {
535 my $sub_module = "$params{sub_module}";
536 $params{sub_module} = sub { $sub_module };
539 my %cfg_map = map { $_->{id} => $_ } @{ $configs };
540 my @cfg_ids = keys %cfg_map;
543 qq|SELECT text_value, timestamp_value, timestamp_value::date AS date_value, number_value, bool_value, config_id
544 FROM custom_variables
545 WHERE (config_id IN (| . join(', ', ('?') x scalar(@cfg_ids)) . qq|))
547 AND (sub_module = ?)|;
548 my $sth = prepare_query($form, $dbh, $query);
550 foreach my $row (@{ $params{data} }) {
551 do_statement($form, $sth, $query, @cfg_ids, conv_i($row->{$params{trans_id_field}}), $params{sub_module}->($row));
553 while (my $ref = $sth->fetchrow_hashref()) {
554 my $cfg = $cfg_map{$ref->{config_id}};
556 $row->{"cvar_$cfg->{name}"} =
557 $cfg->{type} eq 'date' ? $ref->{date_value}
558 : $cfg->{type} eq 'timestamp' ? $ref->{timestamp_value}
559 : $cfg->{type} eq 'number' ? $form->format_amount($myconfig, $ref->{number_value} * 1, $cfg->{precision})
560 : $cfg->{type} eq 'bool' ? ($ref->{bool_value} ? $locale->text('Yes') : $locale->text('No'))
561 : $ref->{text_value};
567 $main::lxdebug->leave_sub();
570 sub get_field_format_list {
571 $main::lxdebug->enter_sub();
576 Common::check_params(\%params, qw(module));
578 my $myconfig = \%main::myconfig;
579 my $form = $main::form;
581 my $dbh = $params{dbh} || $form->get_standard_dbh($myconfig);
583 my $configs = $self->get_configs(%params);
585 my $date_fields = [];
586 my $number_fields = {};
588 foreach my $config (@{ $configs }) {
589 my $name = "$params{prefix}cvar_$config->{name}";
591 if ($config->{type} eq 'date') {
592 push @{ $date_fields }, $name;
594 } elsif ($config->{type} eq 'number') {
595 $number_fields->{$config->{precision}} ||= [];
596 push @{ $number_fields->{$config->{precision}} }, $name;
600 $main::lxdebug->leave_sub();
602 return ($date_fields, $number_fields);
607 Suppose the following scenario:
609 You have a lot of parts in your database, and a set of properties cofigured. Now not every part has every of these properties, some combinations will just make no sense. In order to clean up your inputs a bit, you want to mark certain combinations as invalid, blocking them from modification and possibly display.
611 Validity is assumed. If you modify validity, you actually save B<invalidity>.
612 iNvalidity is saved as a function of config_id, and the trans_id
614 In the naive way, disable an attribute for a specific id (simple)
617 sub save_custom_variables_validity {
618 $main::lxdebug->enter_sub();
623 Common::check_params(\%params, qw(config_id trans_id validity));
625 my $myconfig = \%main::myconfig;
626 my $form = $main::form;
628 my $dbh = $params{dbh} || $form->get_standard_dbh($myconfig);
630 my (@where, @values);
631 add_token(\@where, \@values, col => "config_id", val => $params{config_id}, esc => \&conv_i);
632 add_token(\@where, \@values, col => "trans_id", val => $params{trans_id}, esc => \&conv_i);
634 my $where = scalar @where ? "WHERE " . join ' AND ', @where : '';
635 my $query = qq|DELETE FROM custom_variables_validity $where|;
637 do_query($form, $dbh, $query, @values);
640 qq|INSERT INTO custom_variables_validity (config_id, trans_id)
642 my $sth = prepare_query($form, $dbh, $query);
644 unless ($params{validity}) {
645 foreach my $config_id (listify $params{config_id}) {
646 foreach my $trans_id (listify $params{trans_id}) {
647 do_statement($form, $sth, $query, conv_i($config_id), conv_i($trans_id));
656 $main::lxdebug->leave_sub();
659 sub get_custom_variables_validity {
660 $main::lxdebug->enter_sub();
665 Common::check_params(\%params, qw(config_id trans_id));
667 my $myconfig = \%main::myconfig;
668 my $form = $main::form;
670 my $dbh = $params{dbh} || $form->get_standard_dbh($myconfig);
672 my $query = qq|SELECT COUNT(*) FROM custom_variables_validity WHERE config_id = ? AND trans_id = ?|;
674 my ($invalid) = selectfirst_array_query($form, $dbh, $query, conv_i($params{config_id}), conv_i($params{trans_id}));
676 $main::lxdebug->leave_sub();