Kosmetik
[kivitendo-erp.git] / SL / DBUpgrade2.pm
1 package SL::DBUpgrade2;
2
3 use SL::Common;
4
5 require Exporter;
6 @ISA = qw(Exporter);
7
8 @EXPORT = qw(parse_dbupdate_controls sort_dbupdate_controls);
9
10 sub parse_dbupdate_controls {
11   $main::lxdebug->enter_sub();
12
13   my ($form, $dbdriver) = @_;
14
15   my $locale = $main::locale;
16
17   local *IN;
18   my %all_controls;
19
20   my $path = "sql/${dbdriver}-upgrade2";
21
22   foreach my $file_name (<$path/*.sql>, <$path/*.pl>) {
23     next unless (open(IN, $file_name));
24
25     my $file = $file_name;
26     $file =~ s|.*/||;
27
28     my $control = {
29       "priority" => 1000,
30       "depends"  => [],
31     };
32
33     while (<IN>) {
34       chomp();
35       next unless (/^(--|\#)\s*\@/);
36       s/^(--|\#)\s*\@//;
37       s/\s*$//;
38       next if ($_ eq "");
39
40       my @fields = split(/\s*:\s*/, $_, 2);
41       next unless (scalar(@fields) == 2);
42
43       if ($fields[0] eq "depends") {
44         push(@{$control->{"depends"}}, split(/\s+/, $fields[1]));
45       } else {
46         $control->{$fields[0]} = $fields[1];
47       }
48     }
49
50     $control->{charset} ||= Common::DEFAULT_CHARSET;
51
52     if (!$control->{"tag"}) {
53       _control_error($form, $file_name, $locale->text("Missing 'tag' field.")) ;
54     }
55
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 - _ ( )"))
58     }
59
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"}))
62     }
63
64     if (!$control->{"description"}) {
65       _control_error($form, $file_name, sprintf($locale->text("Missing 'description' field."))) ;
66     }
67
68     $control->{"priority"}  *= 1;
69     $control->{"priority"} ||= 1000;
70     $control->{"file"}       = $file;
71
72     delete @{$control}{qw(depth applied)};
73
74     $all_controls{$control->{"tag"}} = $control;
75
76     close(IN);
77   }
78
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}));
82     }
83
84     map({ $_->{"loop"} = 0; } values(%all_controls));
85     _check_for_loops($form, $control->{"file"}, \%all_controls, $control->{"tag"});
86   }
87
88   map({ _dbupdate2_calculate_depth(\%all_controls, $_->{"tag"}) }
89       values(%all_controls));
90
91   $main::lxdebug->leave_sub();
92
93   return \%all_controls;
94 }
95
96 sub _check_for_loops {
97   my ($form, $file_name, $controls, $tag, @path) = @_;
98
99   push(@path, $tag);
100
101   my $ctrl = $controls->{$tag};
102
103   if ($ctrl->{"loop"} == 1) {
104     # Not done yet.
105     _control_error($form, $file_name, $main::locale->text("Dependency loop detected:") . " " . join(" -> ", @path))
106
107   } elsif ($ctrl->{"loop"} == 0) {
108     # Not checked yet.
109     $ctrl->{"loop"} = 1;
110     map({ _check_for_loops($form, $file_name, $controls, $_, @path); } @{ $ctrl->{"depends"} });
111     $ctrl->{"loop"} = 2;
112   }
113 }
114
115 sub _control_error {
116   my ($form, $file_name, $message) = @_;
117
118   $form = $main::form;
119   my $locale = $main::locale;
120
121   $form->error(sprintf($locale->text("Error in database control file '%s': %s"), $file_name, $message));
122 }
123
124 sub _dbupdate2_calculate_depth {
125   $main::lxdebug->enter_sub();
126
127   my ($tree, $tag) = @_;
128
129   my $node = $tree->{$tag};
130
131   return $main::lxdebug->leave_sub() if (defined($node->{"depth"}));
132
133   my $max_depth = 0;
134
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);
139   }
140
141   $node->{"depth"} = $max_depth + 1;
142
143   $main::lxdebug->leave_sub();
144 }
145
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]}));
150 }
151
152 1;