[3.0] Miscellaneous fixes for the installer and upgrader

Languages/en_US/Maintenance.php

@@ -65,13 +65,7 @@
 $txt['maintenance_step'] = 'Step';
 $txt['maintenance_overall_progress'] = 'Overall Progress';
 $txt['maintenance_substep_progress'] = 'Step Progress';
-$txt['maintenance_time_elasped_ms'] = 'Time Elapsed {m, plural,
-	one {# minute}
-	other {# minutes}
-} and {s, plural,
-	one {# second}
-	other {# seconds}
-}';
+$txt['maintenance_time_elapsed'] = 'Time Elapsed: ';
 
 // File Permissions.
 $txt['chmod_linux_info'] = 'If you have a shell account, the following command can automatically correct permissions on these files';

Sources/Config.php

@@ -998,23 +998,23 @@ public static function set(array $settings): void
 		}
 
 		// Make sure the paths are correct... at least try to fix them.
-		if (empty(self::$boarddir) || !is_dir(realpath(self::$boarddir))) {
+		if (empty(self::$boarddir) || !is_dir((string) realpath(self::$boarddir))) {
 			self::$boarddir = !empty($_SERVER['SCRIPT_FILENAME']) ? \dirname(realpath($_SERVER['SCRIPT_FILENAME'])) : \dirname(__DIR__);
 		}
 
-		if ((empty(self::$sourcedir) || !is_dir(realpath(self::$sourcedir))) && is_dir(self::$boarddir . '/Sources')) {
+		if ((empty(self::$sourcedir) || !is_dir((string) realpath(self::$sourcedir))) && is_dir(self::$boarddir . '/Sources')) {
 			self::$sourcedir = self::$boarddir . '/Sources';
 		}
 
-		if ((empty(self::$vendordir) || !is_dir(realpath(self::$vendordir))) && is_dir(self::$boarddir . '/vendor')) {
+		if ((empty(self::$vendordir) || !is_dir((string) realpath(self::$vendordir))) && is_dir(self::$boarddir . '/vendor')) {
 			self::$vendordir = self::$boarddir . '/vendor';
 		}
 
-		if ((empty(self::$packagesdir) || !is_dir(realpath(self::$packagesdir))) && is_dir(self::$boarddir . '/Packages')) {
+		if ((empty(self::$packagesdir) || !is_dir((string) realpath(self::$packagesdir))) && is_dir(self::$boarddir . '/Packages')) {
 			self::$packagesdir = self::$boarddir . '/Packages';
 		}
 
-		if ((empty(self::$languagesdir) || !is_dir(realpath(self::$languagesdir))) && is_dir(self::$boarddir . '/Languages')) {
+		if ((empty(self::$languagesdir) || !is_dir((string) realpath(self::$languagesdir))) && is_dir(self::$boarddir . '/Languages')) {
 			self::$languagesdir = self::$boarddir . '/Languages';
 		}
 

Sources/Db/APIs/MySQL.php

@@ -938,19 +938,29 @@ public function backup_table(string $table, string $backup_table): object|bool
 			],
 		);
 
-		// If this failed, we go old school.
 		if ($result) {
+			$columns = [];
+
+			// Do we have any generated columns to deal with?
+			foreach ($this->list_columns($table, true) as $column) {
+				// Skip generated columns in the insert statement.
+				if (empty($column['generation_expression'])) {
+					$columns[] = $column['name'];
+				}
+			}
+
 			$request = $this->query(
 				'INSERT INTO {raw:backup_table}
-				SELECT *
+				({raw:columns})
+				SELECT {raw:columns}
 				FROM {raw:table}',
 				[
 					'backup_table' => $backup_table,
 					'table' => $table,
+					'columns' => implode(', ', $columns),
 				],
 			);
 
-			// Old school or no school?
 			if ($request) {
 				return $request;
 			}
@@ -1047,6 +1057,13 @@ public function backup_table(string $table, string $backup_table): object|bool
 			);
 		}
 
+		// Restore the generation expressions on any generated columns.
+		foreach ($this->list_columns($table, true) as $column) {
+			if (!empty($column['generation_expression'])) {
+				$this->change_column($backup_table, $column['name'], $column);
+			}
+		}
+
 		return $request;
 	}
 
@@ -2136,7 +2153,7 @@ public function list_columns(string $table_name, bool $detail = false, array $pa
 				}
 
 				if (str_contains($row['Extra'], 'GENERATED')) {
-					$columns[$row['Field']]['generation_expression'] = $row['generation_expression'];
+					$columns[$row['Field']]['generation_expression'] = $this->unescape_string($row['generation_expression']);
 					$columns[$row['Field']]['stored'] = str_contains($row['Extra'], 'STORED');
 				}
 			}

Sources/Db/Schema/Table.php

@@ -563,6 +563,7 @@ public function populate(bool $replace = false): int
 	/**
 	 * Gets all known table schemas.
 	 *
+	 * @param string $schema_version A string like 'v3_0'.
 	 * @return array All known table schemas.
 	 */
 	final public static function getAll(string $schema_version): array
@@ -594,15 +595,16 @@ final public static function getAll(string $schema_version): array
 	}
 
 	/**
-	 * Gets all known table schemas.
+	 * Gets database initializer queries for the indicated SMF version.
 	 *
+	 * @param string $schema_version A string like 'v3_0'.
 	 * @return array All known table schemas.
 	 */
-	final public static function getInitializers(string $schema_version, string $title): array
+	final public static function getInitializers(string $schema_version): array
 	{
-		if (file_exists(__DIR__ . '/' . $schema_version . '/Initialize/' . $title . '.php')) {
+		if (file_exists(__DIR__ . '/' . $schema_version . '/Initialize/' . Db::$db->title . '.php')) {
 
-			$fully_qualified_class_name = __NAMESPACE__ . '\\' . $schema_version . '\\Initialize\\' . $title;
+			$fully_qualified_class_name = __NAMESPACE__ . '\\' . $schema_version . '\\Initialize\\' . Db::$db->title;
 
 			if (!class_exists($fully_qualified_class_name)) {
 				return [];

Sources/Db/Schema/v2_1/BanGroups.php

@@ -61,6 +61,8 @@ public function __construct()
 				name: 'expire_time',
 				type: 'int',
 				unsigned: true,
+				not_null: false,
+				default: null,
 			),
 			'cannot_access' => new Column(
 				name: 'cannot_access',

Sources/Db/Schema/v3_0/Initialize/Base.php

@@ -31,21 +31,41 @@ class Base
 	 * Public methods
 	 ****************/
 
-	public function __construct(?string $version)
+	/**
+	 * Constructor.
+	 *
+	 * @param string $version Version of the database engine.
+	 */
+	public function __construct(string $version)
 	{
 		$this->version = $version;
 	}
 
+	/**
+	 * Gets queries that create custom SQL functions and operators.
+	 *
+	 * @return array SQL queries.
+	 */
 	public function getAll(): array
 	{
 		return $this->functions() + $this->operators();
 	}
 
+	/**
+	 * Gets queries that create custom SQL functions.
+	 *
+	 * @return array SQL queries.
+	 */
 	public function functions(): array
 	{
 		return [];
 	}
 
+	/**
+	 * Gets queries that create custom SQL operators.
+	 *
+	 * @return array SQL queries.
+	 */
 	public function operators(): array
 	{
 		return [];

Sources/Maintenance/Cleanup/CleanupBase.php

@@ -38,9 +38,7 @@ abstract class CleanupBase implements SubStepInterface
 	 ****************/
 
 	/**
-	 * Check if the task should be performed or not.
 	 *
-	 * @return bool True if this task needs to be run, false otherwise.
 	 */
 	public function isCandidate(): bool
 	{

Sources/Maintenance/Cleanup/v3_0/OldFiles.php → Sources/Maintenance/Cleanup/OldFilesBase.php

@@ -13,13 +13,16 @@
 
 declare(strict_types=1);
 
-namespace SMF\Maintenance\Cleanup\v3_0;
+namespace SMF\Maintenance\Cleanup;
 
 use SMF\Config;
-use SMF\Maintenance\Cleanup\CleanupBase;
 use SMF\Utils;
 
-class OldFiles extends CleanupBase
+/**
+ * Base class for cleanup tasks that delete files that have been removed in a
+ * new version of SMF.
+ */
+abstract class OldFilesBase extends CleanupBase
 {
 	/*******************
 	 * Public properties
@@ -37,7 +40,7 @@ class OldFiles extends CleanupBase
 	/**
 	 * @var array
 	 *
-	 * List of files removed in SMF 3.0.
+	 * List of files removed in the relevant version of SMF.
 	 */
 	protected array $removed = [
 		// Files in the Themes directory.
@@ -57,9 +60,7 @@ class OldFiles extends CleanupBase
 	 ****************/
 
 	/**
-	 * Check if the task should be performed or not.
 	 *
-	 * @return bool True if this task needs to be run, false otherwise.
 	 */
 	public function isCandidate(): bool
 	{

Sources/Maintenance/Cleanup/v2_1/OldFiles.php

@@ -15,10 +15,10 @@
 
 namespace SMF\Maintenance\Cleanup\v2_1;
 
-use SMF\Maintenance\Cleanup\v3_0\OldFiles as OldFilesBase;
+use SMF\Maintenance\Cleanup\OldFilesBase;
 
 /**
- * Just like the v3_0 version of OldFiles, but with a different list of files.
+ * Deletes files that were present in SMF 2.0 but not in SMF 2.1.
  */
 class OldFiles extends OldFilesBase
 {

Sources/Maintenance/Cleanup/v3_0/TasksDirCase.php

@@ -35,9 +35,7 @@ class TasksDirCase extends CleanupBase
 	 ****************/
 
 	/**
-	 * Check if the task should be performed or not.
 	 *
-	 * @return bool True if this task needs to be run, false otherwise.
 	 */
 	public function isCandidate(): bool
 	{

Sources/Maintenance/Maintenance.php

@@ -228,7 +228,7 @@ class Maintenance
 	public function __construct()
 	{
 		Security::frameOptionsHeader('SAMEORIGIN');
-		self::$theme_dir = \dirname(SMF_SETTINGS_FILE) . '/Themes/default';
+		self::$theme_dir = self::getBaseDir() . '/Themes/default';
 
 		// This might be overwritten by the tool, but we need a default value.
 		self::$context['started'] = (int) TIME_START;
@@ -744,12 +744,17 @@ public static function loginWithDatabasePassword(
 	 */
 	public static function getTimeElapsed(): string
 	{
-		// How long have we been running this?
-		$elapsed = time() - (int) self::$context['started'];
-		$mins = (int) ($elapsed / 60);
-		$seconds = $elapsed - $mins * 60;
+		$duration = (new \DateTime('@' . self::$context['started']))->diff(new \DateTime());
 
-		return Lang::getTxt('maintenance_time_elasped_ms', ['m' => $mins, 's' => $seconds]);
+		if ((int) $duration->format('%a') > 0) {
+			return \strval((int) $duration->format('%h') + ((int) $duration->format('%a') * 24)) . $duration->format(':%I:%S');
+		}
+
+		if ((int) $duration->format('%h') > 0) {
+			return $duration->format('%h:%I:%S');
+		}
+
+		return $duration->format('%i:%S');
 	}
 
 	/**

Sources/Maintenance/Migration/v2_1/PostgreSqlSequences.php

@@ -248,7 +248,7 @@ public function execute(): bool
 				[
 					'key' => Config::$db_prefix . $value['key'],
 					'field' => $value['field'],
-					'table' => $value['table'],
+					'table' => Config::$db_prefix . $value['table'],
 				],
 			);
 		}

Sources/Maintenance/Migration/v3_0/PostgreSqlFunctions.php

@@ -49,7 +49,7 @@ public function execute(): bool
 	{
 		$schema_version = substr(__NAMESPACE__, strrpos(__NAMESPACE__, '\\', -1) + 1);
 
-		$queries = Table::getInitializers($schema_version, POSTGRE_TITLE);
+		$queries = Table::getInitializers($schema_version);
 
 		foreach ($queries as $query) {
 			// Use the upgrade query handler.

Sources/Maintenance/Tools/Install.php

@@ -742,7 +742,7 @@ public function databasePopulation(): bool
 		// Some initialization may exist.
 		Db::$db->disableQueryCheck = true;
 
-		foreach (Table::getInitializers($this->schema_version, Db::$db->title) as $query) {
+		foreach (Table::getInitializers($this->schema_version) as $query) {
 			Db::$db->query($query, [
 				'security_override' => true,
 			]);

Sources/Maintenance/Tools/ToolsBase.php

@@ -559,7 +559,7 @@ public function checkAndHandleTimeout(): void
 			Maintenance::setQueryString();
 		}
 
-		Maintenance::exit();
+		Maintenance::exit(Maintenance::isJson());
 
 		throw new \Exception('Zombies!');
 	}
@@ -585,6 +585,15 @@ public function updateSettingsFile(array $config_vars, ?bool $keep_quotes = null
 			$this->logProgress(Lang::getTxt('log_settings_file_save', ['setting_names' => Lang::sentenceList(array_keys($config_vars))], file: 'Maintenance'), true);
 		}
 
+		if ($rebuild) {
+			// Remove all the existing comments to make the rebuild nice and clean.
+			Config::safeFileWrite(
+				file: SMF_SETTINGS_FILE,
+				data: Config::stripPhpComments(file_get_contents(SMF_SETTINGS_FILE)),
+				mtime: time(),
+			);
+		}
+
 		if (!Config::updateSettingsFile($config_vars, $keep_quotes, $rebuild)) {
 			$this->logProgress(Lang::getTxt('log_failed_with_error', ['error' => Lang::getTxt('settings_error', file: 'Maintenance')], file: 'Maintenance'));