kivitendo/scripts/dbupgrade2_tool.pl @ e2edfbac
| 4fd8bdbf | Moritz Bunkus | #!/usr/bin/perl
|
||
BEGIN {
|
||||
if (! -d "bin" || ! -d "SL") {
|
||||
print("This tool must be run from the Lx-Office ERP base directory.\n");
|
||||
exit(1);
|
||||
}
|
||||
| 3f65b4fb | Moritz Bunkus | |||
| b179b8df | Moritz Bunkus | 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.
|
||||
| 4fd8bdbf | Moritz Bunkus | }
|
||
| a6a8a9a8 | Moritz Bunkus | use English '-no_match_vars';
|
||
| 4fd8bdbf | Moritz Bunkus | use DBI;
|
||
use Data::Dumper;
|
||||
use Getopt::Long;
|
||||
use SL::LXDebug;
|
||||
$lxdebug = LXDebug->new();
|
||||
| 0e65146d | Moritz Bunkus | use SL::Auth;
|
||
| 4fd8bdbf | Moritz Bunkus | use SL::Form;
|
||
| a6a8a9a8 | Moritz Bunkus | use SL::User;
|
||
| e0cb5a6c | Moritz Bunkus | use SL::Locale;
|
||
| 4fd8bdbf | Moritz Bunkus | use SL::DBUpgrade2;
|
||
| a6a8a9a8 | Moritz Bunkus | use SL::DBUtils;
|
||
| 4fd8bdbf | Moritz Bunkus | |||
#######
|
||||
#######
|
||||
#######
|
||||
| a6a8a9a8 | Moritz Bunkus | my ($opt_list, $opt_tree, $opt_rtree, $opt_nodeps, $opt_graphviz, $opt_help);
|
||
| 7e96894a | Moritz Bunkus | my ($opt_user, $opt_apply, $opt_applied);
|
||
| a6a8a9a8 | Moritz Bunkus | |||
| 0e65146d | Moritz Bunkus | our (%myconfig, $form, $user, $auth);
|
||
| a6a8a9a8 | Moritz Bunkus | |||
| 4fd8bdbf | Moritz Bunkus | sub show_help {
|
||
| 92fc1394 | Moritz Bunkus | 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'.
|
||||
| 487910f2 | Moritz Bunkus | --nodeps List all database upgrades that no other upgrade
|
||
depends on
|
||||
| 92fc1394 | Moritz Bunkus | --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.
|
||||
| 7e96894a | Moritz Bunkus | --applied List the applied database upgrades for the
|
||
database that the user given with '--user' uses.
|
||||
| 92fc1394 | Moritz Bunkus | --help Show this help and exit.
|
||
Options:
|
||||
--user=name The name of the user configuration to use for
|
||||
database connectivity.
|
||||
END_HELP
|
||||
;
|
||||
| 487910f2 | Moritz Bunkus | # Syntax-Highlighting-Fix f?r Emacs: '
|
||
| 92fc1394 | Moritz Bunkus | print $help_text;
|
||
| 487910f2 | Moritz Bunkus | |||
| 92fc1394 | Moritz Bunkus | exit 0;
|
||
| a6a8a9a8 | Moritz Bunkus | }
|
||
sub error {
|
||||
| 4fd8bdbf | Moritz Bunkus | }
|
||
sub calc_rev_depends {
|
||||
| a96f9e80 | Moritz Bunkus | map { $_->{rev_depends} = []; } values %{ $controls };
|
||
foreach my $control (values %{ $controls }) {
|
||||
map { push @{ $controls->{$_}->{rev_depends} }, $control->{tag} } @{ $control->{depends} };
|
||||
| 4fd8bdbf | Moritz Bunkus | }
|
||
}
|
||||
sub dump_list {
|
||||
my @sorted_controls = sort_dbupdate_controls($controls);
|
||||
| a96f9e80 | Moritz Bunkus | print "LIST VIEW\n\n" .
|
||
"number tag depth priority\n";
|
||||
| 4fd8bdbf | Moritz Bunkus | $i = 0;
|
||
foreach (@sorted_controls) {
|
||||
| a96f9e80 | Moritz Bunkus | print "$i $_->{tag} $_->{depth} $_->{priority}\n";
|
||
| 4fd8bdbf | Moritz Bunkus | $i++;
|
||
}
|
||||
| a96f9e80 | Moritz Bunkus | print "\n";
|
||
| 4fd8bdbf | Moritz Bunkus | }
|
||
sub dump_node {
|
||||
my ($tag, $depth) = @_;
|
||||
| a96f9e80 | Moritz Bunkus | print " " x $depth . $tag . "\n";
|
||
| 4fd8bdbf | Moritz Bunkus | |||
| a96f9e80 | Moritz Bunkus | foreach my $dep_tag (@{ $controls->{$tag}->{depends} }) {
|
||
dump_node($dep_tag, $depth + 1);
|
||||
| 4fd8bdbf | Moritz Bunkus | }
|
||
}
|
||||
sub dump_tree {
|
||||
| a96f9e80 | Moritz Bunkus | print "TREE VIEW\n\n";
|
||
| 4fd8bdbf | Moritz Bunkus | |||
calc_rev_depends();
|
||||
my @sorted_controls = sort_dbupdate_controls($controls);
|
||||
foreach my $control (@sorted_controls) {
|
||||
| a96f9e80 | Moritz Bunkus | dump_node($control->{tag}, "") unless (@{ $control->{rev_depends} });
|
||
| 4fd8bdbf | Moritz Bunkus | }
|
||
| a96f9e80 | Moritz Bunkus | print "\n";
|
||
| 4fd8bdbf | Moritz Bunkus | }
|
||
sub dump_node_reverse {
|
||||
my ($tag, $depth) = @_;
|
||||
| a96f9e80 | Moritz Bunkus | print " " x $depth . $tag . "\n";
|
||
| 4fd8bdbf | Moritz Bunkus | |||
| a96f9e80 | Moritz Bunkus | foreach my $dep_tag (@{ $controls->{$tag}->{rev_depends} }) {
|
||
dump_node_reverse($dep_tag, $depth + 1);
|
||||
| 4fd8bdbf | Moritz Bunkus | }
|
||
}
|
||||
sub dump_tree_reverse {
|
||||
| a96f9e80 | Moritz Bunkus | print "REVERSE TREE VIEW\n\n";
|
||
| 4fd8bdbf | Moritz Bunkus | |||
calc_rev_depends();
|
||||
my @sorted_controls = sort_dbupdate_controls($controls);
|
||||
foreach my $control (@sorted_controls) {
|
||||
| a96f9e80 | Moritz Bunkus | last if ($control->{depth} > 1);
|
||
dump_node_reverse($control->{tag}, "");
|
||||
| 4fd8bdbf | Moritz Bunkus | }
|
||
| a96f9e80 | Moritz Bunkus | print "\n";
|
||
| 4fd8bdbf | Moritz Bunkus | }
|
||
sub dump_graphviz {
|
||||
| 92fc1394 | Moritz Bunkus | my $file_name = shift || "db_dependencies.ps";
|
||
| a96f9e80 | Moritz Bunkus | print "GRAPHVIZ POSTCRIPT\n\n";
|
||
print "Output will be written to '${file_name}'\n";
|
||||
| 0c128c20 | Moritz Bunkus | |||
calc_rev_depends();
|
||||
| 4fd8bdbf | Moritz Bunkus | $dot = "|dot -Tps ";
|
||
| 0c128c20 | Moritz Bunkus | open OUT, "${dot}> \"${file_name}\"" || die;
|
||
| a96f9e80 | Moritz Bunkus | print OUT
|
||
"digraph db_dependencies {\n" .
|
||||
| fdec9e46 | Moritz Bunkus | "graph [size=\"16.53,11.69!\"];\n" .
|
||
| a96f9e80 | Moritz Bunkus | "node [shape=box style=filled fillcolor=white];\n";
|
||
| 4fd8bdbf | Moritz Bunkus | my %ranks;
|
||
| a96f9e80 | Moritz Bunkus | foreach my $c (values %{ $controls }) {
|
||
$ranks{$c->{depth}} ||= [];
|
||||
| 0c128c20 | Moritz Bunkus | |||
| a96f9e80 | Moritz Bunkus | my ($pre, $post) = ('node [fillcolor=lightgray] ', 'node [fillcolor=white] ') if (!scalar @{ $c->{rev_depends} });
|
||
| 0c128c20 | Moritz Bunkus | |||
push @{ $ranks{$c->{"depth"}} }, qq|${pre}"$c->{tag}"; ${post}|;
|
||||
| 4fd8bdbf | Moritz Bunkus | }
|
||
| a96f9e80 | Moritz Bunkus | |||
foreach (sort keys %ranks) {
|
||||
| 0c128c20 | Moritz Bunkus | print OUT "{ rank = same; ", join("", @{ $ranks{$_} }), " }\n";
|
||
| 4fd8bdbf | Moritz Bunkus | }
|
||
| a96f9e80 | Moritz Bunkus | |||
foreach my $c (values %{ $controls }) {
|
||||
print OUT "$c->{tag};\n";
|
||||
foreach my $d (@{ $c->{depends} }) {
|
||||
print OUT "$c->{tag} -> $d;\n";
|
||||
| 4fd8bdbf | Moritz Bunkus | }
|
||
}
|
||||
| a96f9e80 | Moritz Bunkus | |||
print OUT "}\n";
|
||||
close OUT;
|
||||
| 4fd8bdbf | Moritz Bunkus | }
|
||
sub dump_nodeps {
|
||||
calc_rev_depends();
|
||||
| a96f9e80 | Moritz Bunkus | print "SCRIPTS NO OTHER SCRIPTS DEPEND ON\n\n" .
|
||
join("\n", map { $_->{tag} } grep { !scalar @{ $_->{rev_depends} } } values %{ $controls }) .
|
||||
"\n\n";
|
||||
| 4fd8bdbf | Moritz Bunkus | }
|
||
| a6a8a9a8 | Moritz Bunkus | sub apply_upgrade {
|
||
my $name = shift;
|
||||
| acd67df0 | Moritz Bunkus | my (@order, %tags, @all_tags);
|
||
| a6a8a9a8 | Moritz Bunkus | |||
| acd67df0 | Moritz Bunkus | if ($name eq "ALL") {
|
||
calc_rev_depends();
|
||||
| a96f9e80 | Moritz Bunkus | @all_tags = map { $_->{tag} } grep { !@{$_->{rev_depends}} } values %{ $controls };
|
||
| a6a8a9a8 | Moritz Bunkus | |||
| acd67df0 | Moritz Bunkus | } else {
|
||
$form->error("Unknown dbupgrade tag '$name'") if (!$controls->{$name});
|
||||
@all_tags = ($name);
|
||||
}
|
||||
foreach my $tag (@all_tags) {
|
||||
build_upgrade_order($tag, \@order, \%tags);
|
||||
}
|
||||
| a6a8a9a8 | Moritz Bunkus | |||
| a96f9e80 | Moritz Bunkus | my @upgradescripts = map { $controls->{$_}->{applied} = 0; $controls->{$_} } @order;
|
||
| a6a8a9a8 | Moritz Bunkus | |||
my $dbh = $form->dbconnect_noauto(\%myconfig);
|
||||
$dbh->{PrintWarn} = 0;
|
||||
$dbh->{PrintError} = 0;
|
||||
$user->create_schema_info_table($form, $dbh);
|
||||
my $query = qq|SELECT tag FROM schema_info|;
|
||||
$sth = $dbh->prepare($query);
|
||||
$sth->execute() || $form->dberror($query);
|
||||
while (($tag) = $sth->fetchrow_array()) {
|
||||
| a96f9e80 | Moritz Bunkus | $controls->{$tag}->{applied} = 1 if defined $controls->{$tag};
|
||
| a6a8a9a8 | Moritz Bunkus | }
|
||
$sth->finish();
|
||||
| a96f9e80 | Moritz Bunkus | @upgradescripts = sort { $a->{priority} <=> $b->{priority} } grep { !$_->{applied} } @upgradescripts;
|
||
| acd67df0 | Moritz Bunkus | if (!@upgradescripts) {
|
||
| a6a8a9a8 | Moritz Bunkus | print "The upgrade has already been applied.\n";
|
||
exit 0;
|
||||
}
|
||||
foreach my $control (@upgradescripts) {
|
||||
| a96f9e80 | Moritz Bunkus | $control->{file} =~ /\.(sql|pl)$/;
|
||
| a6a8a9a8 | Moritz Bunkus | my $file_type = $1;
|
||
# apply upgrade
|
||||
print "Applying upgrade $control->{file}\n";
|
||||
if ($file_type eq "sql") {
|
||||
$user->process_query($form, $dbh, "sql/$form->{dbdriver}-upgrade2/$control->{file}", $control);
|
||||
} else {
|
||||
$user->process_perl_script($form, $dbh, "sql/$form->{dbdriver}-upgrade2/$control->{file}", $control);
|
||||
}
|
||||
}
|
||||
$dbh->disconnect();
|
||||
}
|
||||
| 7e96894a | Moritz Bunkus | sub dump_sql_result {
|
||
my ($results, $column_order) = @_;
|
||||
my %column_lengths = map { $_, length $_ } keys %{ $results->[0] };
|
||||
foreach my $row (@{ $results }) {
|
||||
map { $column_lengths{$_} = length $row->{$_} if (length $row->{$_} > $column_lengths{$_}) } keys %{ $row };
|
||||
}
|
||||
my @sorted_names;
|
||||
if ($column_order && scalar @{ $column_order }) {
|
||||
@sorted_names = @{ $column_order };
|
||||
} else {
|
||||
@sorted_names = sort keys %column_lengths;
|
||||
}
|
||||
my $format = join('|', map { '%-' . $column_lengths{$_} . 's' } @sorted_names) . "\n";
|
||||
printf $format, @sorted_names;
|
||||
print join('+', map { '-' x $column_lengths{$_} } @sorted_names) . "\n";
|
||||
foreach my $row (@{ $results }) {
|
||||
printf $format, map { $row->{$_} } @sorted_names;
|
||||
}
|
||||
printf "(\%d row\%s)\n", scalar @{ $results }, scalar @{ $results } > 1 ? 's' : '';
|
||||
}
|
||||
sub dump_applied {
|
||||
my @results;
|
||||
my $dbh = $form->dbconnect_noauto(\%myconfig);
|
||||
$dbh->{PrintWarn} = 0;
|
||||
$dbh->{PrintError} = 0;
|
||||
$user->create_schema_info_table($form, $dbh);
|
||||
my $query = qq|SELECT tag, login, itime FROM schema_info ORDER BY itime|;
|
||||
$sth = $dbh->prepare($query);
|
||||
$sth->execute() || $form->dberror($query);
|
||||
while (my $ref = $sth->fetchrow_hashref()) {
|
||||
push @results, $ref;
|
||||
}
|
||||
$sth->finish();
|
||||
$dbh->disconnect();
|
||||
if (!scalar @results) {
|
||||
print "No database upgrades have been applied yet.\n";
|
||||
} else {
|
||||
dump_sql_result(\@results, [qw(tag login itime)]);
|
||||
}
|
||||
}
|
||||
| a6a8a9a8 | Moritz Bunkus | sub build_upgrade_order {
|
||
my $name = shift;
|
||||
my $order = shift;
|
||||
my $tag = shift;
|
||||
my $control = $controls->{$name};
|
||||
| a96f9e80 | Moritz Bunkus | foreach my $dependency (@{ $control->{depends} }) {
|
||
| a6a8a9a8 | Moritz Bunkus | next if $tags->{$dependency};
|
||
$tags->{$dependency} = 1;
|
||||
build_upgrade_order($dependency, $order, $tag);
|
||||
}
|
||||
push @{ $order }, $name;
|
||||
| acd67df0 | Moritz Bunkus | $tags->{$name} = 1;
|
||
| a6a8a9a8 | Moritz Bunkus | }
|
||
| 4fd8bdbf | Moritz Bunkus | #######
|
||
#######
|
||||
#######
|
||||
| a96f9e80 | Moritz Bunkus | eval { require "config/lx-erp.conf"; };
|
||
eval { require "config/lx-erp-local.conf"; } if (-f "config/lx-erp-local.conf");
|
||||
| 4fd8bdbf | Moritz Bunkus | |||
$form = Form->new();
|
||||
$locale = Locale->new("de", "login");
|
||||
#######
|
||||
#######
|
||||
#######
|
||||
| a96f9e80 | Moritz Bunkus | GetOptions("list" => \$opt_list,
|
||
"tree" => \$opt_tree,
|
||||
"rtree" => \$opt_rtree,
|
||||
"nodeps" => \$opt_nodeps,
|
||||
| 92fc1394 | Moritz Bunkus | "graphviz:s" => \$opt_graphviz,
|
||
| a96f9e80 | Moritz Bunkus | "user=s" => \$opt_user,
|
||
"apply=s" => \$opt_apply,
|
||||
| 7e96894a | Moritz Bunkus | "applied" => \$opt_applied,
|
||
| a96f9e80 | Moritz Bunkus | "help" => \$opt_help,
|
||
| 4fd8bdbf | Moritz Bunkus | );
|
||
| a96f9e80 | Moritz Bunkus | show_help() if ($opt_help);
|
||
| 4fd8bdbf | Moritz Bunkus | |||
$controls = parse_dbupdate_controls($form, "Pg");
|
||||
| a96f9e80 | Moritz Bunkus | dump_list() if ($opt_list);
|
||
dump_tree() if ($opt_tree);
|
||||
dump_tree_reverse() if ($opt_rtree);
|
||||
dump_graphviz($opt_graphviz) if (defined $opt_graphviz);
|
||||
dump_nodeps() if ($opt_nodeps);
|
||||
| a6a8a9a8 | Moritz Bunkus | |||
if ($opt_user) {
|
||||
| 0e65146d | Moritz Bunkus | $auth = SL::Auth->new();
|
||
if (!$auth->session_tables_present()) {
|
||||
$form->error("The session and user management tables are not present in the " .
|
||||
"authentication database. Please use the administration web interface " .
|
||||
"and to create them.");
|
||||
}
|
||||
%myconfig = $auth->read_user($opt_user);
|
||||
if (!$myconfig{login}) {
|
||||
$form->error($form->format_string("The user '#1' does not exist.", $opt_user));
|
||||
}
|
||||
| a6a8a9a8 | Moritz Bunkus | |||
$locale = new Locale($myconfig{countrycode}, "all");
|
||||
| 0e65146d | Moritz Bunkus | $user = new User($opt_user);
|
||
| a6a8a9a8 | Moritz Bunkus | map { $form->{$_} = $myconfig{$_} } keys %myconfig;
|
||
}
|
||||
if ($opt_apply) {
|
||||
| 7e96894a | Moritz Bunkus | $form->error("--apply used but no user name given with --user.") if (!$user);
|
||
| a6a8a9a8 | Moritz Bunkus | apply_upgrade($opt_apply);
|
||
}
|
||||
| 7e96894a | Moritz Bunkus | |||
if ($opt_applied) {
|
||||
$form->error("--applied used but no user name given with --user.") if (!$user);
|
||||
dump_applied();
|
||||
}
|