rose_auto_create_model: auf Eintrag in %kivitendo_package_names bestehen

[mfinanz.git] / scripts / dbupgrade2_tool.pl

diff --git a/scripts/dbupgrade2_tool.pl b/scripts/dbupgrade2_tool.pl
index 253706c93df1c89fddff72b134a100bbeab189b5..9b1e9e0d8349ede8454aa44451f2e0f47acbb1d5 100755 (executable)
--- a/scripts/dbupgrade2_tool.pl
+++ b/scripts/dbupgrade2_tool.pl
@@ -2,7 +2,7 @@
 
 BEGIN {
   if (! -d "bin" || ! -d "SL") {
 
 BEGIN {
   if (! -d "bin" || ! -d "SL") {

-    print("This tool must be run from the Lx-Office ERP base directory.\n");
+    print("This tool must be run from the kivitendo ERP base directory.\n");

     exit(1);
   }
 
     exit(1);
   }
 


@@ -42,11 +42,23 @@ use SL::Dispatcher;
 #######
 
 my ($opt_list, $opt_tree, $opt_rtree, $opt_nodeps, $opt_graphviz, $opt_help);
 #######
 
 my ($opt_list, $opt_tree, $opt_rtree, $opt_nodeps, $opt_graphviz, $opt_help);

-my ($opt_user, $opt_apply, $opt_applied, $opt_unapplied, $opt_format, $opt_test_utf8);
-my ($opt_dbhost, $opt_dbport, $opt_dbname, $opt_dbuser, $opt_dbpassword);
+my ($opt_user, $opt_client, $opt_apply, $opt_applied, $opt_unapplied, $opt_format, $opt_test_utf8);
+my ($opt_dbhost, $opt_dbport, $opt_dbname, $opt_dbuser, $opt_dbpassword, $opt_create, $opt_type);
+my ($opt_description, $opt_encoding, @opt_depends, $opt_auth_db);

 
 our (%myconfig, $form, $user, $auth, $locale, $controls, $dbupgrader);
 
 
 our (%myconfig, $form, $user, $auth, $locale, $controls, $dbupgrader);
 

+sub connect_auth {
+  return $auth if $auth;
+
+  $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 to create them.");
+  }
+
+  return $auth;
+}
+

 sub show_help {
   my $help_text = <<"END_HELP"
 dbupgrade2_tool.pl [options]
 sub show_help {
   my $help_text = <<"END_HELP"
 dbupgrade2_tool.pl [options]


@@ -72,6 +84,10 @@ dbupgrade2_tool.pl [options]
                          for it\'s option \'-T\' are acceptable.
     --nodeps             List all database upgrades that no other upgrade
                          depends on
                          for it\'s option \'-T\' are acceptable.
     --nodeps             List all database upgrades that no other upgrade
                          depends on

+    --create=tag         Creates a new upgrade with the supplied tag. This
+                         action accepts several optional other options. See
+                         the option section for those. After creating the
+                         upgrade file your \$EDITOR will be called with it.

     --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.
     --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.


@@ -86,15 +102,31 @@ dbupgrade2_tool.pl [options]
                          and --dbpassword.
     --help               Show this help and exit.
 
                          and --dbpassword.
     --help               Show this help and exit.
 

-  Options:
+  General Options:
+    --client=id-or-name  The name (or database ID) of the client to use for
+                         database connectivity. You must provide both a client
+                         and a user.

     --user=name          The name of the user configuration to use for
     --user=name          The name of the user configuration to use for

-                         database connectivity.
+                         database connectivity. You must provide both a client
+                         and a user.
+    --auth-db            Work on the authentication database instead of a
+                         user database.

     --dbname=name        Database connection options for the UTF-8
     --dbhost=host        handling test.
     --dbport=port
     --dbuser=user
     --dbpassword=pw
 
     --dbname=name        Database connection options for the UTF-8
     --dbhost=host        handling test.
     --dbport=port
     --dbuser=user
     --dbpassword=pw
 

+  Options for --create:
+    --type               \'sql\' or \'pl\'. Defaults to sql.
+    --description        The description field of the generated upgrade.
+    --encoding           Encoding used for the file. Defaults to \'utf8\'.
+                         Note: Your editor will not be told to open the file in
+                         this encoding.
+    --depends            Tags of upgrades which this upgrade depends upon.
+                         Defaults to the latest stable release upgrade.
+                         Multiple values possible.
+

 END_HELP
 ;
 
 END_HELP
 ;
 


@@ -231,6 +263,50 @@ sub dump_nodeps {
     "\n\n";
 }
 
     "\n\n";
 }
 

+sub create_upgrade {
+  my (%params) = @_;
+
+  my $filename    = $params{filename};
+  my $dbupgrader  = $params{dbupgrader};
+  my $type        = $params{type}        || 'sql';
+  my $description = $params{description} || '';
+  my $encoding    = $params{encoding}    || 'utf-8';
+  my @depends     = @{ $params{depends} };
+
+  if (!@depends) {
+    my @releases = grep { /^release_/ } keys %$controls;
+    @depends = ((sort @releases)[-1]);
+  }
+
+  my $comment;
+  if ($type eq 'sql') {
+    $comment = '--';
+  } elsif ($type eq 'pl') {
+    $comment = '#';
+  } elsif (!$type) {
+    die 'Error: No --type was given but is required for --create.';
+  } else {
+    die 'Error: Unknown --type. Try "sql" or "pl".';
+  }
+
+  my $full_filename = $dbupgrader->path . '/' . $filename . '.' . $type;
+
+  die "file '$full_filename' already exists, aborting" if -f $full_filename;
+
+
+  open my $fh, ">:encoding($encoding)", $full_filename or die "can't open $full_filename";
+  print $fh "$comment \@tag: $filename\n";
+  print $fh "$comment \@description: $description\n";
+  print $fh "$comment \@depends: @depends\n";
+  print $fh "$comment \@encoding: $encoding\n";
+  close $fh;
+
+  print "File $full_filename created.\n";
+
+  system("\$EDITOR $full_filename");
+  exit 0;
+}
+

 sub apply_upgrade {
   my $name = shift;
 
 sub apply_upgrade {
   my $name = shift;
 


@@ -251,7 +327,8 @@ sub apply_upgrade {
 
   my @upgradescripts = map { $controls->{$_}->{applied} = 0; $controls->{$_} } @order;
 
 
   my @upgradescripts = map { $controls->{$_}->{applied} = 0; $controls->{$_} } @order;
 

-  my $dbh = $form->dbconnect_noauto(\%myconfig);
+  my $dbh            = $opt_auth_db ? connect_auth()->dbconnect : $form->dbconnect_noauto(\%myconfig);
+  $dbh->{AutoCommit} = 0;

 
   $dbh->{PrintWarn}  = 0;
   $dbh->{PrintError} = 0;
 
   $dbh->{PrintWarn}  = 0;
   $dbh->{PrintError} = 0;


@@ -280,13 +357,13 @@ sub apply_upgrade {
     print "Applying upgrade $control->{file}\n";
 
     if ($file_type eq "sql") {
     print "Applying upgrade $control->{file}\n";
 
     if ($file_type eq "sql") {

-      $dbupgrader->process_query($dbh, "sql/$form->{dbdriver}-upgrade2/$control->{file}", $control);
+      $dbupgrader->process_query($dbh, "sql/Pg-upgrade2/$control->{file}", $control);

     } else {
     } else {

-      $dbupgrader->process_perl_script($dbh, "sql/$form->{dbdriver}-upgrade2/$control->{file}", $control);
+      $dbupgrader->process_perl_script($dbh, "sql/Pg-upgrade2/$control->{file}", $control);

     }
   }
 
     }
   }
 

-  $dbh->disconnect();
+  $dbh->disconnect unless $opt_auth_db;

 }
 
 sub dump_sql_result {
 }
 
 sub dump_sql_result {


@@ -319,7 +396,8 @@ sub dump_sql_result {
 sub dump_applied {
   my @results;
 
 sub dump_applied {
   my @results;
 

-  my $dbh = $form->dbconnect_noauto(\%myconfig);
+  my $dbh            = $opt_auth_db ? connect_auth()->dbconnect : $form->dbconnect_noauto(\%myconfig);
+  $dbh->{AutoCommit} = 0;

 
   $dbh->{PrintWarn}  = 0;
   $dbh->{PrintError} = 0;
 
   $dbh->{PrintWarn}  = 0;
   $dbh->{PrintError} = 0;


@@ -334,7 +412,7 @@ sub dump_applied {
   }
   $sth->finish();
 
   }
   $sth->finish();
 

-  $dbh->disconnect();
+  $dbh->disconnect unless $opt_auth_db;

 
   if (!scalar @results) {
     print "No database upgrades have been applied yet.\n";
 
   if (!scalar @results) {
     print "No database upgrades have been applied yet.\n";


@@ -346,14 +424,14 @@ sub dump_applied {
 sub dump_unapplied {
   my @results;
 
 sub dump_unapplied {
   my @results;
 

-  my $dbh = $form->dbconnect_noauto(\%myconfig);
+  my $dbh = $opt_auth_db ? connect_auth()->dbconnect : $form->dbconnect_noauto(\%myconfig);

 
   $dbh->{PrintWarn}  = 0;
   $dbh->{PrintError} = 0;
 
   my @unapplied = $dbupgrader->unapplied_upgrade_scripts($dbh);
 
 
   $dbh->{PrintWarn}  = 0;
   $dbh->{PrintError} = 0;
 
   my @unapplied = $dbupgrader->unapplied_upgrade_scripts($dbh);
 

-  $dbh->disconnect;
+  $dbh->disconnect unless $opt_auth_db;

 
   if (!scalar @unapplied) {
     print "All database upgrades have been applied.\n";
 
   if (!scalar @unapplied) {
     print "All database upgrades have been applied.\n";


@@ -397,8 +475,14 @@ GetOptions("list"         => \$opt_list,
            "graphviz:s"   => \$opt_graphviz,
            "format:s"     => \$opt_format,
            "user=s"       => \$opt_user,
            "graphviz:s"   => \$opt_graphviz,
            "format:s"     => \$opt_format,
            "user=s"       => \$opt_user,

+           "client=s"     => \$opt_client,

            "apply=s"      => \$opt_apply,
            "applied"      => \$opt_applied,
            "apply=s"      => \$opt_apply,
            "applied"      => \$opt_applied,

+           "create=s"     => \$opt_create,
+           "type=s"       => \$opt_type,
+           "encoding=s"   => \$opt_encoding,
+           "description=s" => \$opt_description,
+           "depends=s"    => \@opt_depends,

            "unapplied"    => \$opt_unapplied,
            "test-utf8"    => \$opt_test_utf8,
            "dbhost:s"     => \$opt_dbhost,
            "unapplied"    => \$opt_unapplied,
            "test-utf8"    => \$opt_test_utf8,
            "dbhost:s"     => \$opt_dbhost,


@@ -406,12 +490,13 @@ GetOptions("list"         => \$opt_list,
            "dbname:s"     => \$opt_dbname,
            "dbuser:s"     => \$opt_dbuser,
            "dbpassword:s" => \$opt_dbpassword,
            "dbname:s"     => \$opt_dbname,
            "dbuser:s"     => \$opt_dbuser,
            "dbpassword:s" => \$opt_dbpassword,

+           "auth-db"      => \$opt_auth_db,

            "help"         => \$opt_help,
   );
 
 show_help() if ($opt_help);
 
            "help"         => \$opt_help,
   );
 
 show_help() if ($opt_help);
 

-$dbupgrader = SL::DBUpgrade2->new(form => $form, dbdriver => 'Pg');
+$dbupgrader = SL::DBUpgrade2->new(form => $form, auth => $opt_auth_db);

 $controls   = $dbupgrader->parse_dbupdate_controls->{all_controls};
 
 dump_list()                                 if ($opt_list);
 $controls   = $dbupgrader->parse_dbupdate_controls->{all_controls};
 
 dump_list()                                 if ($opt_list);


@@ -420,16 +505,21 @@ dump_tree_reverse()                         if ($opt_rtree);
 dump_graphviz('file_name' => $opt_graphviz,
               'format'    => $opt_format)   if (defined $opt_graphviz);
 dump_nodeps()                               if ($opt_nodeps);
 dump_graphviz('file_name' => $opt_graphviz,
               'format'    => $opt_format)   if (defined $opt_graphviz);
 dump_nodeps()                               if ($opt_nodeps);

+create_upgrade(filename   => $opt_create,
+               dbupgrader  => $dbupgrader,
+               type        => $opt_type,
+               description => $opt_description,
+               encoding    => $opt_encoding,
+               depends     => \@opt_depends) if ($opt_create);
+
+if ($opt_client && !connect_auth()->set_client($opt_client)) {
+  $form->error($form->format_string("The client '#1' does not exist.", $opt_client));
+}

 
 if ($opt_user) {
 
 if ($opt_user) {

-  $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.");
-  }
+  $form->error("Need a client, too.") if !$auth || !$auth->client;

 
 

-  %myconfig = $auth->read_user(login => $opt_user);
+  %myconfig = connect_auth()->read_user(login => $opt_user);

 
   if (!$myconfig{login}) {
     $form->error($form->format_string("The user '#1' does not exist.", $opt_user));
 
   if (!$myconfig{login}) {
     $form->error($form->format_string("The user '#1' does not exist.", $opt_user));


@@ -442,20 +532,21 @@ if ($opt_user) {
 }
 
 if ($opt_apply) {
 }
 
 if ($opt_apply) {

-  $form->error("--apply used but no user name given with --user.") if (!$user);
+  $form->error("--apply used but no user name given with --user.") if !$user && !$opt_auth_db;

   apply_upgrade($opt_apply);
 }
 
 if ($opt_applied) {
   apply_upgrade($opt_apply);
 }
 
 if ($opt_applied) {

-  $form->error("--applied used but no user name given with --user.") if (!$user);
+  $form->error("--applied used but no user name given with --user.") if !$user && !$opt_auth_db;

   dump_applied();
 }
 
 if ($opt_unapplied) {
   dump_applied();
 }
 
 if ($opt_unapplied) {

-  $form->error("--unapplied used but no user name given with --user.") if (!$user);
+  $form->error("--unapplied used but no user name given with --user.") if !$user && !$opt_auth_db;

   dump_unapplied();
 }
 
   dump_unapplied();
 }
 

+

 if ($opt_test_utf8) {
   $form->error("--test-utf8 used but no database name given with --dbname.") if (!$opt_dbname);
 
 if ($opt_test_utf8) {
   $form->error("--test-utf8 used but no database name given with --dbname.") if (!$opt_dbname);