1 package SL::DBUpgrade2;
8 @EXPORT = qw(parse_dbupdate_controls sort_dbupdate_controls);
10 sub parse_dbupdate_controls {
11 $main::lxdebug->enter_sub();
13 my ($form, $dbdriver) = @_;
15 my $locale = $main::locale;
20 my $path = "sql/${dbdriver}-upgrade2";
22 foreach my $file_name (<$path/*.sql>, <$path/*.pl>) {
23 next unless (open(IN, $file_name));
25 my $file = $file_name;
35 next unless (/^(--|\#)\s*\@/);
40 my @fields = split(/\s*:\s*/, $_, 2);
41 next unless (scalar(@fields) == 2);
43 if ($fields[0] eq "depends") {
44 push(@{$control->{"depends"}}, split(/\s+/, $fields[1]));
46 $control->{$fields[0]} = $fields[1];
50 $control->{charset} ||= Common::DEFAULT_CHARSET;
52 if (!$control->{"tag"}) {
53 _control_error($form, $file_name, $locale->text("Missing 'tag' field.")) ;
56 if ($control->{"tag"} =~ /[^a-zA-Z0-9_\(\)\-]/) {
57 _control_error($form, $file_name, $locale->text("The 'tag' field must only consist of alphanumeric characters or the carachters - _ ( )"))
60 if (defined($all_controls{$control->{"tag"}})) {
61 _control_error($form, $file_name, sprintf($locale->text("More than one control file with the tag '%s' exist."), $control->{"tag"}))
64 if (!$control->{"description"}) {
65 _control_error($form, $file_name, sprintf($locale->text("Missing 'description' field."))) ;
68 $control->{"priority"} *= 1;
69 $control->{"priority"} ||= 1000;
70 $control->{"file"} = $file;
72 delete @{$control}{qw(depth applied)};
74 $all_controls{$control->{"tag"}} = $control;
79 foreach my $control (values(%all_controls)) {
80 foreach my $dependency (@{$control->{"depends"}}) {
81 _control_error($form, $control->{"file"}, sprintf($locale->text("Unknown dependency '%s'."), $dependency)) if (!defined($all_controls{$dependency}));
84 map({ $_->{"loop"} = 0; } values(%all_controls));
85 _check_for_loops($form, $control->{"file"}, \%all_controls, $control->{"tag"});
88 map({ _dbupdate2_calculate_depth(\%all_controls, $_->{"tag"}) }
89 values(%all_controls));
91 $main::lxdebug->leave_sub();
93 return \%all_controls;
96 sub _check_for_loops {
97 my ($form, $file_name, $controls, $tag, @path) = @_;
101 my $ctrl = $controls->{$tag};
103 if ($ctrl->{"loop"} == 1) {
105 _control_error($form, $file_name, $main::locale->text("Dependency loop detected:") . " " . join(" -> ", @path))
107 } elsif ($ctrl->{"loop"} == 0) {
110 map({ _check_for_loops($form, $file_name, $controls, $_, @path); } @{ $ctrl->{"depends"} });
116 my ($form, $file_name, $message) = @_;
119 my $locale = $main::locale;
121 $form->error(sprintf($locale->text("Error in database control file '%s': %s"), $file_name, $message));
124 sub _dbupdate2_calculate_depth {
125 $main::lxdebug->enter_sub();
127 my ($tree, $tag) = @_;
129 my $node = $tree->{$tag};
131 return $main::lxdebug->leave_sub() if (defined($node->{"depth"}));
135 foreach $tag (@{$node->{"depends"}}) {
136 _dbupdate2_calculate_depth($tree, $tag);
137 my $value = $tree->{$tag}->{"depth"};
138 $max_depth = $value if ($value > $max_depth);
141 $node->{"depth"} = $max_depth + 1;
143 $main::lxdebug->leave_sub();
146 sub sort_dbupdate_controls {
147 return sort({ $a->{"depth"} != $b->{"depth"} ? $a->{"depth"} <=> $b->{"depth"}
148 : $a->{"priority"} != $b->{"priority"} ? $a->{"priority"} <=> $b->{"priority"}
149 : $a->{"tag"} cmp $b->{"tag"} } values(%{$_[0]}));