Umstellung der Vorlagen aus templates/webpages/drafts von HTML::Template auf Template.

[kivitendo-erp.git] / scripts / dbupgrade2_tool.pl

diff --git a/scripts/dbupgrade2_tool.pl b/scripts/dbupgrade2_tool.pl
index e936247..1d1403e 100755 (executable)
--- a/scripts/dbupgrade2_tool.pl
+++ b/scripts/dbupgrade2_tool.pl
@@ -6,7 +6,8 @@ BEGIN {
     exit(1);
   }
 
-  push(@INC, "modules");
+  unshift @INC, "modules/override"; # Use our own versions of various modules (e.g. YAML).
+  push    @INC, "modules/fallback"; # Only use our own versions of modules if there's no system version.
 }
 
 use English '-no_match_vars';
@@ -35,8 +36,43 @@ my ($opt_user, $opt_apply);
 our (%myconfig, $form, $user);
 
 sub show_help {
-  print("dbupgrade2_tool.pl [--list] [--tree] [--rtree] [--graphviz]\n" .
-        "                   [--nodepds] [--user=name --apply=tag] [--help]\n");
+  my $help_text = <<'END_HELP'
+dbupgrade2_tool.pl [options]
+
+  A validation and information tool for the database upgrade scripts
+  in 'sql/Pg-upgrade2'.
+
+  At startup dbupgrade2_tool.pl will always check the consistency
+  of all database upgrade scripts (e.g. circular references, invalid
+  formats, missing meta information). You can but don't have to specifiy
+  additional actions.
+
+  Actions:
+    --list               Lists all database upgrade tags
+    --tree               Lists all database upgrades in tree form
+    --rtree              Lists all database upgrades in reverse tree form
+    --graphviz[=file]    Create a Postscript document showing a tree of
+                         all database upgrades and their dependencies.
+                         If no file name is given then the output is
+                         written to 'db_dependencies.ps'.
+    --nodeps             List all database upgrades that no other upgrade
+                         depends on
+    --apply=tag          Applies the database upgrades 'tag' and all
+                         upgrades it depends on. If '--apply' is used
+                         then the option '--user' must be used as well.
+    --help               Show this help and exit.
+
+  Options:
+    --user=name          The name of the user configuration to use for
+                         database connectivity.
+END_HELP
+    ;
+
+  # Syntax-Highlighting-Fix für Emacs: '
+
+  print $help_text;
+
+  exit 0;
 }
 
 sub error {
@@ -118,22 +154,29 @@ sub dump_tree_reverse {
 }
 
 sub dump_graphviz {
+  my $file_name = shift || "db_dependencies.ps";
+
   print("GRAPHVIZ POSTCRIPT\n\n");
-  print("Output will be written to db_dependencies.ps\n");
+  print("Output will be written to '${file_name}'\n");
+
+  calc_rev_depends();
+
   $dot = "|dot -Tps ";
-  open(OUT, "${dot}> db_dependencies.ps");
+  open OUT, "${dot}> \"${file_name}\"" || die;
+
   print(OUT
         "digraph db_dependencies {\n" .
-        "node [shape=box];\n");
+        "node [shape=box style=filled fillcolor=white];\n");
   my %ranks;
   foreach my $c (values(%{$controls})) {
-    $ranks{$c->{"depth"}} = [] unless ($ranks{$c->{"depth"}});
-    push(@{$ranks{$c->{"depth"}}}, $c->{"tag"});
+    $ranks{$c->{"depth"}} ||= [];
+
+    my ($pre, $post) = ('node [fillcolor=lightgray] ', 'node [fillcolor=white] ') if !@{ $c->{"rev_depends"} };
+
+    push @{ $ranks{$c->{"depth"}} }, qq|${pre}"$c->{tag}"; ${post}|;
   }
   foreach (sort(keys(%ranks))) {
-    print(OUT "{ rank = same; " .
-          join("", map({ '"' . $_ . '"; ' } @{$ranks{$_}})) .
-          " }\n");
+    print OUT "{ rank = same; ", join("", @{ $ranks{$_} }), " }\n";
   }
   foreach my $c (values(%{$controls})) {
     print(OUT "$c->{tag};\n");
@@ -159,11 +202,20 @@ sub dump_nodeps {
 sub apply_upgrade {
   my $name = shift;
 
-  $form->error("Unknown dbupgrade tag '$name'") if (!$controls->{$name});
+  my (@order, %tags, @all_tags);
 
-  my (@order, %tags);
+  if ($name eq "ALL") {
+    calc_rev_depends();
+    @all_tags = map { $_->{"tag"} } grep { !@{$_->{"rev_depends"}} } values %{$controls};
 
-  build_upgrade_order($name, \@order, \%tags);
+  } else {
+    $form->error("Unknown dbupgrade tag '$name'") if (!$controls->{$name});
+    @all_tags = ($name);
+  }
+
+  foreach my $tag (@all_tags) {
+    build_upgrade_order($tag, \@order, \%tags);
+  }
 
   my @upgradescripts = map { $controls->{$_}->{"applied"} = 0; $controls->{$_} } @order;
 
@@ -182,22 +234,13 @@ sub apply_upgrade {
   }
   $sth->finish();
 
-  my $all_applied = 1;
-  foreach (@upgradescripts) {
-    if (!$_->{"applied"}) {
-      $all_applied = 0;
-      last;
-    }
-  }
-
-  if ($all_applied) {
+  @upgradescripts = sort { $a->{"priority"} <=> $b->{"priority"} } grep { !$_->{"applied"} } @upgradescripts;
+  if (!@upgradescripts) {
     print "The upgrade has already been applied.\n";
     exit 0;
   }
 
   foreach my $control (@upgradescripts) {
-    next if ($control->{"applied"});
-
     $control->{"file"} =~ /\.(sql|pl)$/;
     my $file_type = $1;
 
@@ -228,6 +271,7 @@ sub build_upgrade_order {
   }
 
   push @{ $order }, $name;
+  $tags->{$name} = 1;
 }
 
 #######
@@ -247,7 +291,7 @@ GetOptions("list" => \$opt_list,
            "tree" => \$opt_tree,
            "rtree" => \$opt_rtree,
            "nodeps" => \$opt_nodeps,
-           "graphviz" => \$opt_graphviz,
+           "graphviz:s" => \$opt_graphviz,
            "user=s" => \$opt_user,
            "apply=s" => \$opt_apply,
            "help" => \$opt_help,
@@ -255,7 +299,6 @@ GetOptions("list" => \$opt_list,
 
 if ($opt_help) {
   show_help();
-  exit(0);
 }
 
 $controls = parse_dbupdate_controls($form, "Pg");
@@ -272,8 +315,8 @@ if ($opt_rtree) {
   dump_tree_reverse();
 }
 
-if ($opt_graphviz) {
-  dump_graphviz();
+if (defined $opt_graphviz) {
+  dump_graphviz($opt_graphviz);
 }
 
 if ($opt_nodeps) {