Typos in Doku

[mfinanz.git] / SL / DBUpgrade2.pm

diff --git a/SL/DBUpgrade2.pm b/SL/DBUpgrade2.pm
index 0daec360680ff88a722865703aa2fe6da858b63c..4fb1ba9e20b3aa2733f05ceeeb59fa8f8882b7c8 100644 (file)
--- a/SL/DBUpgrade2.pm
+++ b/SL/DBUpgrade2.pm
@@ -7,7 +7,6 @@ use List::MoreUtils qw(any);
 use SL::Common;
 use SL::DBUpgrade2::Base;
 use SL::DBUtils;
 use SL::Common;
 use SL::DBUpgrade2::Base;
 use SL::DBUtils;

-use SL::Iconv;

 
 use strict;
 
 
 use strict;
 


@@ -27,7 +26,7 @@ sub init {
 
   $params{path_suffix} ||= '';
   $params{schema}      ||= '';
 
   $params{path_suffix} ||= '';
   $params{schema}      ||= '';

-  $params{path}          = "sql/Pg-upgrade2" . $params{path_suffix};
+  $params{path}        ||= "sql/Pg-upgrade2" . $params{path_suffix};

 
   map { $self->{$_} = $params{$_} } keys %params;
 
 
   map { $self->{$_} = $params{$_} } keys %params;
 


@@ -39,8 +38,6 @@ sub path {
 }
 
 sub parse_dbupdate_controls {
 }
 
 sub parse_dbupdate_controls {

-  $::lxdebug->enter_sub();
-

   my ($self) = @_;
 
   my $form   = $self->{form};
   my ($self) = @_;
 
   my $form   = $self->{form};


@@ -52,7 +49,7 @@ sub parse_dbupdate_controls {
   my $path = $self->path;
 
   foreach my $file_name (<$path/*.sql>, <$path/*.pl>) {
   my $path = $self->path;
 
   foreach my $file_name (<$path/*.sql>, <$path/*.pl>) {

-    next unless (open(IN, $file_name));
+    next unless (open(IN, "<:encoding(UTF-8)", $file_name));

 
     my $file = $file_name;
     $file =~ s|.*/||;
 
     my $file = $file_name;
     $file =~ s|.*/||;


@@ -60,6 +57,7 @@ sub parse_dbupdate_controls {
     my $control = {
       "priority" => 1000,
       "depends"  => [],
     my $control = {
       "priority" => 1000,
       "depends"  => [],

+      "locales"  => [],

     };
 
     while (<IN>) {
     };
 
     while (<IN>) {


@@ -74,6 +72,8 @@ sub parse_dbupdate_controls {
 
       if ($fields[0] eq "depends") {
         push(@{$control->{"depends"}}, split(/\s+/, $fields[1]));
 
       if ($fields[0] eq "depends") {
         push(@{$control->{"depends"}}, split(/\s+/, $fields[1]));

+      } elsif ($fields[0] eq "locales") {
+        push @{$control->{locales}}, $fields[1];

       } else {
         $control->{$fields[0]} = $fields[1];
       }
       } else {
         $control->{$fields[0]} = $fields[1];
       }


@@ -81,9 +81,6 @@ sub parse_dbupdate_controls {
 
     next if ($control->{ignore});
 
 
     next if ($control->{ignore});
 

-    $control->{charset} = 'UTF-8' if $file =~ m/\.pl$/;
-    $control->{charset} = $control->{charset} || $control->{encoding} || Common::DEFAULT_CHARSET;
-

     if (!$control->{"tag"}) {
       _control_error($form, $file_name, $locale->text("Missing 'tag' field.")) ;
     }
     if (!$control->{"tag"}) {
       _control_error($form, $file_name, $locale->text("Missing 'tag' field.")) ;
     }


@@ -125,38 +122,28 @@ sub parse_dbupdate_controls {
 
   $self->{all_controls} = \%all_controls;
 
 
   $self->{all_controls} = \%all_controls;
 

-  $::lxdebug->leave_sub();
-

   return $self;
 }
 
 sub process_query {
   $::lxdebug->enter_sub();
 
   return $self;
 }
 
 sub process_query {
   $::lxdebug->enter_sub();
 

-  my ($self, $dbh, $filename, $version_or_control, $db_charset) = @_;
+  my ($self, $dbh, $filename, $version_or_control) = @_;

 
   my $form  = $self->{form};
 
   my $form  = $self->{form};

-  my $fh    = IO::File->new($filename, "r") or $form->error("$filename : $!\n");
+  my $fh    = IO::File->new($filename, "<:encoding(UTF-8)");

   my $query = "";
   my $sth;
   my @quote_chars;
 
   my $query = "";
   my $sth;
   my @quote_chars;
 

-  my $file_charset = Common::DEFAULT_CHARSET;
-  while (<$fh>) {
-    last if !/^--/;
-    next if !/^--\s*\@(?:charset|encoding):\s*(.+)/;
-    $file_charset = $1;
-    last;
+  if (!$fh) {
+    return "No such file: $filename" if $self->{return_on_error};
+    $form->error("$filename : $!\n");

   }
   }

-  $fh->seek(0, SEEK_SET);
-
-  $db_charset ||= Common::DEFAULT_CHARSET;

 
   $dbh->begin_work();
 
   while (<$fh>) {
 
   $dbh->begin_work();
 
   while (<$fh>) {

-    $_ = SL::Iconv::convert($file_charset, $db_charset, $_);
-

     # Remove DOS and Unix style line endings.
     chomp;
 
     # Remove DOS and Unix style line endings.
     chomp;
 


@@ -196,6 +183,7 @@ sub process_query {
           $sth = $dbh->prepare($query);
           if (!$sth->execute()) {
             my $errstr = $dbh->errstr;
           $sth = $dbh->prepare($query);
           if (!$sth->execute()) {
             my $errstr = $dbh->errstr;

+            return $errstr // '<unknown database error>' if $self->{return_on_error};

             $sth->finish();
             $dbh->rollback();
             $form->dberror("The database update/creation did not succeed. " .
             $sth->finish();
             $dbh->rollback();
             $form->dberror("The database update/creation did not succeed. " .


@@ -231,23 +219,27 @@ sub process_query {
   $fh->close();
 
   $::lxdebug->leave_sub();
   $fh->close();
 
   $::lxdebug->leave_sub();

+
+  # Signal "no error"
+  return undef;

 }
 
 # Process a Perl script which updates the database.
 # If the script returns 1 then the update was successful.
 }
 
 # Process a Perl script which updates the database.
 # If the script returns 1 then the update was successful.

-# Return code "2" means "needs more interaction; remove
-# users/nologin and end current request".
+# Return code "2" means "needs more interaction; unlock
+# the system and end current request".

 # All other return codes are fatal errors.
 sub process_perl_script {
   $::lxdebug->enter_sub();
 
 # All other return codes are fatal errors.
 sub process_perl_script {
   $::lxdebug->enter_sub();
 

-  my ($self, $dbh, $filename, $version_or_control, $db_charset) = @_;
+  my ($self, $dbh, $filename, $version_or_control) = @_;

 
 

-  my %form_values = map { $_ => $::form->{$_} } qw(dbconnect dbdefault dbhost dbmbkiviunstable dbname dboptions dbpasswd dbport dbupdate dbuser login template_object version);
+  my %form_values = map { $_ => $::form->{$_} } qw(dbconnect dbdefault dbhost dbname dboptions dbpasswd dbport dbupdate dbuser login template_object version);

 
   $dbh->begin_work;
 
   # setup dbup_ export vars & run script
 
   $dbh->begin_work;
 
   # setup dbup_ export vars & run script

+  my $old_dbh       = $::form->set_standard_dbh($dbh);

   my %dbup_myconfig = map { ($_ => $::form->{$_}) } qw(dbname dbuser dbpasswd dbhost dbport dbconnect);
   my $result        = eval {
     SL::DBUpgrade2::Base::execute_script(
   my %dbup_myconfig = map { ($_ => $::form->{$_}) } qw(dbname dbuser dbpasswd dbhost dbport dbconnect);
   my $result        = eval {
     SL::DBUpgrade2::Base::execute_script(


@@ -260,13 +252,17 @@ sub process_perl_script {
 
   my $error = $EVAL_ERROR;
 
 
   my $error = $EVAL_ERROR;
 

+  $::form->set_standard_dbh($old_dbh);
+

   $dbh->rollback if 1 != ($result // -1);
 
   $dbh->rollback if 1 != ($result // -1);
 

+  return $error if $self->{return_on_error} && (1 != ($result // -1));
+

   if (!defined($result)) {
     print $::form->parse_html_template("dbupgrade/error", { file  => $filename, error => $error });
     ::end_of_request();
   } elsif (1 != $result) {
   if (!defined($result)) {
     print $::form->parse_html_template("dbupgrade/error", { file  => $filename, error => $error });
     ::end_of_request();
   } elsif (1 != $result) {

-    unlink("users/nologin") if (2 == $result);
+    SL::System::InstallationLock->unlock if 2 == $result;

     ::end_of_request();
   }
 
     ::end_of_request();
   }
 


@@ -275,7 +271,8 @@ sub process_perl_script {
   } elsif ($version_or_control) {
     $dbh->do("UPDATE defaults SET version = " . $dbh->quote($version_or_control));
   }
   } elsif ($version_or_control) {
     $dbh->do("UPDATE defaults SET version = " . $dbh->quote($version_or_control));
   }

-  $dbh->commit();
+
+  $dbh->commit if !$dbh->{AutoCommit} || $dbh->{BegunWork};

 
   # Clear $::form of values that may have been set so that following
   # Perl upgrade scripts won't have to work with old data (think of
 
   # Clear $::form of values that may have been set so that following
   # Perl upgrade scripts won't have to work with old data (think of


@@ -285,50 +282,15 @@ sub process_perl_script {
   $::form->{$_} = $form_values{$_} for keys %form_values;
 
   $::lxdebug->leave_sub();
   $::form->{$_} = $form_values{$_} for keys %form_values;
 
   $::lxdebug->leave_sub();

-}
-
-sub process_file {
-  my ($self, $dbh, $filename, $version_or_control, $db_charset) = @_;
-
-  if ($filename =~ m/sql$/) {
-    $self->process_query($dbh, $filename, $version_or_control, $db_charset);
-  } else {
-    $self->process_perl_script($dbh, $filename, $version_or_control, $db_charset);
-  }
-}

 
 

-sub update_available {
-  my ($self, $cur_version) = @_;
-
-  local *SQLDIR;
-
-  opendir SQLDIR, "sql/Pg-upgrade" || error("", "sql/Pg-upgrade: $!");
-  my @upgradescripts = grep /Pg-upgrade-\Q$cur_version\E.*\.(sql|pl)$/, readdir SQLDIR;
-  closedir SQLDIR;
-
-  return ($#upgradescripts > -1);
+  return undef;

 }
 
 }
 

-sub update2_available {
-  $::lxdebug->enter_sub();
-
-  my ($self, $dbh) = @_;
-
-  map { $_->{applied} = 0; } values %{ $self->{all_controls} };
-
-  my $sth = $dbh->prepare(qq|SELECT tag FROM | . $self->{schema} . qq|schema_info|);
-  if ($sth->execute) {
-    while (my ($tag) = $sth->fetchrow_array) {
-      $self->{all_controls}->{$tag}->{applied} = 1 if defined $self->{all_controls}->{$tag};
-    }
-  }
-  $sth->finish();
-
-  my $needs_update = any { !$_->{applied} } values %{ $self->{all_controls} };
-
-  $::lxdebug->leave_sub();
+sub process_file {
+  my ($self, $dbh, $filename, $version_or_control) = @_;

 
 

-  return $needs_update;
+  return $filename =~ m/sql$/ ? $self->process_query(      $dbh, $filename, $version_or_control)
+                              : $self->process_perl_script($dbh, $filename, $version_or_control);

 }
 
 sub unapplied_upgrade_scripts {
 }
 
 sub unapplied_upgrade_scripts {


@@ -347,6 +309,14 @@ sub unapplied_upgrade_scripts {
   return grep { !$_->{applied} } @all_scripts;
 }
 
   return grep { !$_->{applied} } @all_scripts;
 }
 

+sub update2_available {
+  my ($self, $dbh) = @_;
+
+  my @unapplied_scripts = $self->unapplied_upgrade_scripts($dbh);
+
+  return !!@unapplied_scripts;
+}
+

 sub apply_admin_dbupgrade_scripts {
   my ($self, $called_from_admin) = @_;
 
 sub apply_admin_dbupgrade_scripts {
   my ($self, $called_from_admin) = @_;
 


@@ -357,11 +327,8 @@ sub apply_admin_dbupgrade_scripts {
 
   return 0 if !@unapplied_scripts;
 
 
   return 0 if !@unapplied_scripts;
 

-  my $db_charset           = $::lx_office_conf{system}->{dbcharset} || Common::DEFAULT_CHARSET;

   $self->{form}->{login} ||= 'admin';
 
   $self->{form}->{login} ||= 'admin';
 

-  map { $_->{description} = SL::Iconv::convert($_->{charset}, $db_charset, $_->{description}) } values %{ $self->{all_controls} };
-

   if ($called_from_admin) {
     $self->{form}->{title} = $::locale->text('Dataset upgrade');
     $self->{form}->header;
   if ($called_from_admin) {
     $self->{form}->{title} = $::locale->text('Dataset upgrade');
     $self->{form}->header;


@@ -373,7 +340,7 @@ sub apply_admin_dbupgrade_scripts {
     $::lxdebug->message(LXDebug->DEBUG2(), "Applying Update $control->{file}");
     print $self->{form}->parse_html_template("dbupgrade/upgrade_message2", $control);
 
     $::lxdebug->message(LXDebug->DEBUG2(), "Applying Update $control->{file}");
     print $self->{form}->parse_html_template("dbupgrade/upgrade_message2", $control);
 

-    $self->process_file($dbh, "sql/Pg-upgrade2-auth/$control->{file}", $control, $db_charset);
+    $self->process_file($dbh, "sql/Pg-upgrade2-auth/$control->{file}", $control);

   }
 
   print $self->{form}->parse_html_template("dbupgrade/footer", { is_admin => 1 }) if $called_from_admin;
   }
 
   print $self->{form}->parse_html_template("dbupgrade/footer", { is_admin => 1 }) if $called_from_admin;


@@ -410,13 +377,11 @@ sub _control_error {
 }
 
 sub _dbupdate2_calculate_depth {
 }
 
 sub _dbupdate2_calculate_depth {

-  $::lxdebug->enter_sub(2);
-

   my ($tree, $tag) = @_;
 
   my $node = $tree->{$tag};
 
   my ($tree, $tag) = @_;
 
   my $node = $tree->{$tag};
 

-  return $::lxdebug->leave_sub(2) if (defined($node->{"depth"}));
+  return if (defined($node->{"depth"}));

 
   my $max_depth = 0;
 
 
   my $max_depth = 0;
 


@@ -427,8 +392,6 @@ sub _dbupdate2_calculate_depth {
   }
 
   $node->{"depth"} = $max_depth + 1;
   }
 
   $node->{"depth"} = $max_depth + 1;

-
-  $::lxdebug->leave_sub(2);

 }
 
 sub sort_dbupdate_controls {
 }
 
 sub sort_dbupdate_controls {


@@ -449,8 +412,7 @@ __END__
 =head1 NAME
 
 SL::DBUpgrade2 - Parse database upgrade files stored in
 =head1 NAME
 
 SL::DBUpgrade2 - Parse database upgrade files stored in

-C<sql/Pg-upgrade2> and C<sql/Pg-upgrade2-auth> (and also in
-C<SQL/Pg-upgrade>)
+C<sql/Pg-upgrade2> and C<sql/Pg-upgrade2-auth>

 
 =head1 SYNOPSIS
 
 
 =head1 SYNOPSIS
 


@@ -469,7 +431,9 @@ C<SQL/Pg-upgrade>)
     form     => $::form,
     auth     => 1
   );
     form     => $::form,
     auth     => 1
   );

-  User->dbupdate2($form, $scripts->parse_dbupdate_controls);
+  User->dbupdate2(form     => $form,
+                  updater  => $scripts->parse_dbupdate_controls,
+                  database => $dbname);

 
 =head1 OVERVIEW
 
 
 =head1 OVERVIEW
 


@@ -496,14 +460,8 @@ applied.
 
 Database upgrade files come in two flavours: SQL files and Perl
 files. For both there are control fields that determine the order in
 
 Database upgrade files come in two flavours: SQL files and Perl
 files. For both there are control fields that determine the order in

-which they're executed, what charset the scripts are written in
-etc. The control fields are tag/value pairs contained in comments.
-
-=head1 OLD UPGRADE FILES
-
-The files in C<sql/Pg-upgrade> are so old that I don't bother
-documenting them. They're handled by this class, too, but new files
-are only created as C<Pg-upgrade2> files.
+which they're executed etc. The control fields are tag/value pairs
+contained in comments.

 
 =head1 CONTROL FIELDS
 
 
 =head1 CONTROL FIELDS
 


@@ -548,13 +506,6 @@ A space-separated list of tags of scripts this particular script
 depends on. All other upgrades listed in C<depends> will be applied
 before the current one is applied.
 
 depends on. All other upgrades listed in C<depends> will be applied
 before the current one is applied.
 

-=item charset
-
-=item encoding
-
-The charset this file uses. Defaults to C<ISO-8859-15> if
-missing. Both terms are recognized.
-

 =item priority
 
 Ordering the scripts by their dependencies alone produces a lot of
 =item priority
 
 Ordering the scripts by their dependencies alone produces a lot of


@@ -615,30 +566,27 @@ are missing/wrong (e.g. a tag name listed in C<depends> is not
 found). Sets C<$Self-&gt;{all_controls}> to the list of database
 scripts.
 
 found). Sets C<$Self-&gt;{all_controls}> to the list of database
 scripts.
 

-=item C<process_file $dbh, $filename, $version_or_control, $db_charset>
+=item C<process_file $dbh, $filename, $version_or_control>

 
 Applies a single database upgrade file. Calls L<process_perl_script>
 for Perl update files and C<process_query> for SQL update
 files. Requires an open database handle(C<$dbh>), the file name
 
 Applies a single database upgrade file. Calls L<process_perl_script>
 for Perl update files and C<process_query> for SQL update
 files. Requires an open database handle(C<$dbh>), the file name

-(C<$filename>), a hash structure of the file's control fields as
-produced by L<parse_dbupdate_controls> (C<$version_or_control>) and
-the database charset (for on-the-fly charset recoding of the script if
-required, C<$db_charset>).
+(C<$filename>) and a hash structure of the file's control fields as
+produced by L<parse_dbupdate_controls> (C<$version_or_control>).

 
 Returns the result of the actual function called.
 
 
 Returns the result of the actual function called.
 

-=item C<process_perl_script $dbh, $filename, $version_or_control, $db_charset>
+=item C<process_perl_script $dbh, $filename, $version_or_control>

 
 Applies a single Perl database upgrade file. Requires an open database
 
 Applies a single Perl database upgrade file. Requires an open database

-handle(C<$dbh>), the file name (C<$filename>), a hash structure of the
-file's control fields as produced by L<parse_dbupdate_controls>
-(C<$version_or_control>) and the database charset (for on-the-fly
-charset recoding of the script if required, C<$db_charset>).
+handle(C<$dbh>), the file name (C<$filename>) and a hash structure of
+the file's control fields as produced by L<parse_dbupdate_controls>
+(C<$version_or_control>).

 
 Perl scripts are executed via L<eval>. If L<eval> returns falsish then
 an error is expected. There are two special return values: If the
 script returns C<1> then the update was successful. Return code C<2>
 
 Perl scripts are executed via L<eval>. If L<eval> returns falsish then
 an error is expected. There are two special return values: If the
 script returns C<1> then the update was successful. Return code C<2>

-means "needs more interaction from the user; remove users/nologin and
+means "needs more interaction from the user; unlock the system and

 end current upgrade process". All other return codes are fatal errors.
 
 Inside the Perl script several local variables exist that can be used:
 end current upgrade process". All other return codes are fatal errors.
 
 Inside the Perl script several local variables exist that can be used:


@@ -673,13 +621,12 @@ the following function:
     }
   }
 
     }
   }
 

-=item C<process_query $dbh, $filename, $version_or_control, $db_charset>
+=item C<process_query $dbh, $filename, $version_or_control>

 
 Applies a single SQL database upgrade file. Requires an open database
 
 Applies a single SQL database upgrade file. Requires an open database

-handle(C<$dbh>), the file name (C<$filename>), a hash structure of the
-ofile's control fields as produced by L<parse_dbupdate_controls>
-(C<$version_or_control>) and the database charset (for on-the-fly
-charset recoding of the script if required, C<$db_charset>).
+handle(C<$dbh>), the file name (C<$filename>), and a hash structure of
+the file's control fields as produced by L<parse_dbupdate_controls>
+(C<$version_or_control>).

 
 =item C<sort_dbupdate_controls>
 
 
 =item C<sort_dbupdate_controls>