Bug 1917423: fix for checksetup.pl failing to find the data directory on new install...

This PR removes the need to store the current database charset in the params file, instead detecting it only at runtime and saving it in memory during the operation of checksetup.pl. The params are instead remapped to the detected value if appropriate.

r=dylan

diff --git a/Bugzilla/Config.pm b/Bugzilla/Config.pm
index fc604cf09470eaa888c6f0519908f072b570b125..971a46a2f2048aaa6dd77d4d8d9b31c8527527e9 100644 (file)
--- a/Bugzilla/Config.pm
+++ b/Bugzilla/Config.pm
@@ -134,6 +134,16 @@ sub update_params {
 
   # --- UPDATE OLD PARAMS ---
 
+  # Normalize legacy utf8 values to explicit charset names.
+  if (exists $param->{'utf8'}) {
+    if ($param->{'utf8'} eq '1') {
+      $param->{'utf8'} = 'utf8mb4';
+    }
+    elsif ($param->{'utf8'} eq 'utf8') {
+      $param->{'utf8'} = 'utf8mb3';
+    }
+  }
+
   # Change from usebrowserinfo to defaultplatform/defaultopsys combo
   if (exists $param->{'usebrowserinfo'}) {
     if (!$param->{'usebrowserinfo'}) {
@@ -231,7 +241,7 @@ sub update_params {
     }
   }
 
-  $param->{'utf8'} = 1 if $new_install;
+  $param->{'utf8'} = 'utf8mb4' if $new_install;
 
   # Bug 452525: OR based groups are on by default for new installations
   $param->{'or_groups'} = 1 if $new_install;

diff --git a/Bugzilla/Config/Common.pm b/Bugzilla/Config/Common.pm
index 86103c8f1880fb378d7972ec3d885be0a6d4ffd5..f44dd25f0a974a559538e056f1edd468503889d7 100644 (file)
--- a/Bugzilla/Config/Common.pm
+++ b/Bugzilla/Config/Common.pm
@@ -126,11 +126,18 @@ sub check_ip {
 sub check_utf8 {
   my ($utf8, $entry) = @_;
   # You cannot turn off the UTF-8 parameter.
-  my $current_utf8 = Bugzilla->params->{'utf8'};
   if (!$utf8) {
     return "You cannot disable UTF-8 support.";
   }
-  elsif ($current_utf8 eq 'utf8mb3' && $utf8 ne 'utf8mb3' && $utf8 ne 'utf8mb4') {
+
+  my $current_utf8 = Bugzilla->params->{'utf8'};
+  $current_utf8 = 'utf8mb4' if !defined $current_utf8 || $current_utf8 eq '1';
+  $current_utf8 = 'utf8mb3' if $current_utf8 eq 'utf8';
+
+  $utf8 = 'utf8mb4' if $utf8 eq '1';
+  $utf8 = 'utf8mb3' if $utf8 eq 'utf8';
+
+  if ($current_utf8 eq 'utf8mb3' && $utf8 ne 'utf8mb3' && $utf8 ne 'utf8mb4') {
     return "You cannot downgrade from utf8mb3 support, only keep it or change to utf8mb4.";
   }
   elsif ($current_utf8 eq 'utf8mb4' && $utf8 ne 'utf8mb4') {

diff --git a/Bugzilla/DB/MariaDB.pm b/Bugzilla/DB/MariaDB.pm
index 09e03762e3231a792523112e73c633bda998db2d..6b9b6a1f11e4e5b0176843e059f00d1f644f4b08 100644 (file)
--- a/Bugzilla/DB/MariaDB.pm
+++ b/Bugzilla/DB/MariaDB.pm
@@ -28,7 +28,6 @@ extends qw(Bugzilla::DB);
 
 use Bugzilla::Constants;
 use Bugzilla::Install::Util qw(install_string);
-use Bugzilla::Config;
 use Bugzilla::Util;
 use Bugzilla::Error;
 use Bugzilla::DB::Schema::MariaDB;
@@ -317,10 +316,10 @@ sub bz_setup_database {
   $self->do("CREATE TABLE `utf8_test` (id tinyint) CHARACTER SET ? COLLATE ?", undef, $charset, $collate);
   my ($found_collate) = $self->selectrow_array("SELECT TABLE_COLLATION FROM information_schema.TABLES WHERE TABLE_SCHEMA=? AND TABLE_NAME='utf8_test'", undef, $db_name);
   $self->do("DROP TABLE `utf8_test`");
-  my ($found_charset) = ($found_collate =~ m/^([a-z0-9]+)_/);
-  Bugzilla->params->{'utf8'} = $found_charset;
-  Bugzilla->params->{'utf8_collate'} = $found_collate;
-  Bugzilla::Config::write_params();
+  my ($found_charset)
+    = defined $found_collate ? ($found_collate =~ m/^([a-z0-9]+)_/) : ();
+  $self->{detected_utf8_charset} = $found_charset if defined $found_charset;
+  $self->{detected_utf8_collate} = $found_collate if defined $found_collate;
   # reload these because they get used later.
   $charset = $self->utf8_charset;
   $collate = $self->utf8_collate;
@@ -911,21 +910,33 @@ sub _fix_defaults {
 }
 
 sub utf8_charset {
-  return 'utf8mb4' unless Bugzilla->params->{'utf8'};
-  return 'utf8mb4' if Bugzilla->params->{'utf8'} eq '1';
-  return Bugzilla->params->{'utf8'};
+  my ($self) = @_;
+  if (ref $self && $self->{detected_utf8_charset}) {
+    return $self->{detected_utf8_charset};
+  }
+  my $param = Bugzilla->params->{'utf8'};
+  return 'utf8mb4' unless $param;
+  return 'utf8mb4' if $param eq '1';
+  return 'utf8mb3' if $param eq 'utf8';
+  return $param;
 }
 
 sub utf8_collate {
-  my $charset = utf8_charset();
+  my ($self) = @_;
+  my $charset = $self->utf8_charset;
+  if (ref $self && $self->{detected_utf8_collate}
+    && $self->{detected_utf8_collate} =~ /^${charset}_/)
+  {
+    return $self->{detected_utf8_collate};
+  }
   return $charset . '_unicode_520_ci' unless Bugzilla->params->{'utf8_collate'};
   return $charset . '_unicode_520_ci' unless (Bugzilla->params->{'utf8_collate'} =~ /^${charset}_/);
   return Bugzilla->params->{'utf8_collate'};
 }
 
 sub default_row_format {
-  my ($class, $table) = @_;
-  my $charset = utf8_charset();
+  my ($self, $table) = @_;
+  my $charset = $self->utf8_charset;
   if ($charset eq 'utf8') {
     return 'Compact';
   }
@@ -1201,13 +1212,13 @@ Undocumented methods: utf8_charset, utf8_collate, default_row_format'
 
 Returns the name of the charset to use for utf8 columns.
 This comes from the C<Bugzilla-E<gt>params-E<gt>{utf8}> parameter.
-It can be either true, false, or utf8mb4
+It should be either C<utf8mb3> or C<utf8mb4>. Legacy values are normalized.
 
 =head2 utf8_collate
 
 Returns the name of the collation to use for utf8 columns.
-When C<utf8_charset> is C<utf8mb4> this is C<utf8mb4_unicode_520_ci>.
-Otherwise it is C<utf8_general_ci>.
+By default this is C<< <charset>_unicode_520_ci >> for the selected charset,
+unless an explicit compatible value is configured.
 
 =head2 default_row_format
 

diff --git a/Bugzilla/DB/Mysql.pm b/Bugzilla/DB/Mysql.pm
index 826cd627233c2ea732e8bf3f2a27e3710f3ef693..00ff9b6cb05bff241b40cbf6d39a3eab760a4d82 100644 (file)
--- a/Bugzilla/DB/Mysql.pm
+++ b/Bugzilla/DB/Mysql.pm
@@ -28,7 +28,6 @@ extends qw(Bugzilla::DB);
 
 use Bugzilla::Constants;
 use Bugzilla::Install::Util qw(install_string);
-use Bugzilla::Config;
 use Bugzilla::Util;
 use Bugzilla::Error;
 use Bugzilla::DB::Schema::Mysql;
@@ -317,10 +316,10 @@ sub bz_setup_database {
   $self->do("CREATE TABLE `utf8_test` (id tinyint) CHARACTER SET ? COLLATE ?", undef, $charset, $collate);
   my ($found_collate) = $self->selectrow_array("SELECT TABLE_COLLATION FROM information_schema.TABLES WHERE TABLE_SCHEMA=? AND TABLE_NAME='utf8_test'", undef, $db_name);
   $self->do("DROP TABLE `utf8_test`");
-  my ($found_charset) = ($found_collate =~ m/^([a-z0-9]+)_/);
-  Bugzilla->params->{'utf8'} = $found_charset;
-  Bugzilla->params->{'utf8_collate'} = $found_collate;
-  Bugzilla::Config::write_params();
+  my ($found_charset)
+    = defined $found_collate ? ($found_collate =~ m/^([a-z0-9]+)_/) : ();
+  $self->{detected_utf8_charset} = $found_charset if defined $found_charset;
+  $self->{detected_utf8_collate} = $found_collate if defined $found_collate;
   # reload these because they get used later.
   $charset = $self->utf8_charset;
   $collate = $self->utf8_collate;
@@ -911,22 +910,34 @@ sub _fix_defaults {
 }
 
 sub utf8_charset {
-  return 'utf8mb4' unless Bugzilla->params->{'utf8'};
-  return 'utf8mb4' if Bugzilla->params->{'utf8'} eq '1';
-  return Bugzilla->params->{'utf8'};
+  my ($self) = @_;
+  if (ref $self && $self->{detected_utf8_charset}) {
+    return $self->{detected_utf8_charset};
+  }
+  my $param = Bugzilla->params->{'utf8'};
+  return 'utf8mb4' unless $param;
+  return 'utf8mb4' if $param eq '1';
+  return 'utf8mb3' if $param eq 'utf8';
+  return $param;
 }
 
 sub utf8_collate {
-  my $charset = utf8_charset();
+  my ($self) = @_;
+  my $charset = $self->utf8_charset;
+  if (ref $self && $self->{detected_utf8_collate}
+    && $self->{detected_utf8_collate} =~ /^${charset}_/)
+  {
+    return $self->{detected_utf8_collate};
+  }
   return $charset . '_unicode_520_ci' unless Bugzilla->params->{'utf8_collate'};
   return $charset . '_unicode_520_ci' unless (Bugzilla->params->{'utf8_collate'} =~ /^${charset}_/);
   return Bugzilla->params->{'utf8_collate'};
 }
 
 sub default_row_format {
-  my ($class, $table) = @_;
-  my $charset = utf8_charset();
-  if ($charset eq 'utf8') {
+  my ($self, $table) = @_;
+  my $charset = $self->utf8_charset;
+  if (($charset eq 'utf8') || ($charset eq 'utf8mb3')) {
     return 'Compact';
   }
   elsif ($charset eq 'utf8mb4') {
@@ -1201,13 +1212,13 @@ Undocumented methods: utf8_charset, utf8_collate, default_row_format'
 
 Returns the name of the charset to use for utf8 columns.
 This comes from the C<Bugzilla-E<gt>params-E<gt>{utf8}> parameter.
-It can be either true, false, or utf8mb4
+It should be either C<utf8mb3> or C<utf8mb4>. Legacy values are normalized.
 
 =head2 utf8_collate
 
 Returns the name of the collation to use for utf8 columns.
-When C<utf8_charset> is C<utf8mb4> this is C<utf8mb4_unicode_520_ci>.
-Otherwise it is C<utf8_general_ci>.
+By default this is C<< <charset>_unicode_520_ci >> for the selected charset,
+unless an explicit compatible value is configured.
 
 =head2 default_row_format