Installer and upgrader rewrite

.gitignore

@@ -5,6 +5,7 @@
 !/Languages/en_US/
 /Languages/en_US/agreement.txt
 Settings.php
+!Sources/Db/Schema/*/Settings.php
 Settings_bak.php
 Settings_org.php
 db_last_error.php

Maintenance/Cleanup/CleanupBase.php

@@ -0,0 +1,49 @@
+<?php
+
+/**
+ * Simple Machines Forum (SMF)
+ *
+ * @package SMF
+ * @author Simple Machines https://www.simplemachines.org
+ * @copyright 2024 Simple Machines and individual contributors
+ * @license https://www.simplemachines.org/about/smf/license.php BSD
+ *
+ * @version 3.0 Alpha 2
+ */
+
+declare(strict_types=1);
+
+namespace SMF\Maintenance\Cleanup;
+
+/**
+ * Base class for cleanup tasks.
+ */
+abstract class CleanupBase
+{
+	/*******************
+	 * Public properties
+	 *******************/
+
+	/**
+	 * @var string
+	 *
+	 * Name of the cleanup task.
+	 */
+	public string $name;
+
+	/****************
+	 * Public methods
+	 ****************/
+
+	/**
+	 * Cleanup task we will execute.
+	 *
+	 * @return bool True if successful (or skipped), false otherwise.
+	 */
+	public function execute(): bool
+	{
+		return true;
+	}
+}
+
+?>

Maintenance/Cleanup/CleanupInterface.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * Simple Machines Forum (SMF)
+ *
+ * @package SMF
+ * @author Simple Machines https://www.simplemachines.org
+ * @copyright 2024 Simple Machines and individual contributors
+ * @license https://www.simplemachines.org/about/smf/license.php BSD
+ *
+ * @version 3.0 Alpha 2
+ */
+
+declare(strict_types=1);
+
+namespace SMF\Maintenance\Cleanup;
+
+/**
+ * Cleanup Interface, all tools have these methods.
+ */
+interface CleanupInterface
+{
+	/****************
+	 * Public methods
+	 ****************/
+
+	/**
+	 * Cleanup task we will execute.
+	 *
+	 * @return bool True if successful (or skipped), false otherwise.
+	 */
+	public function execute(): bool;
+}
+
+?>

Maintenance/Cleanup/CleanupOldFiles.php

@@ -0,0 +1,141 @@
+<?php
+
+/**
+ * Simple Machines Forum (SMF)
+ *
+ * @package SMF
+ * @author Simple Machines https://www.simplemachines.org
+ * @copyright 2024 Simple Machines and individual contributors
+ * @license https://www.simplemachines.org/about/smf/license.php BSD
+ *
+ * @version 3.0 Alpha 2
+ */
+
+declare(strict_types=1);
+
+namespace SMF\Maintenance\Cleanup;
+
+use SMF\Config;
+
+class CleanupOldFiles extends CleanupBase
+{
+	/*******************
+	 * Public properties
+	 *******************/
+
+	/**
+	 * {@inheritDoc}
+	 */
+	public string $name = 'Cleanup old files';
+
+	/*********************
+	 * Internal properties
+	 *********************/
+
+	/**
+	 * @var array
+	 *
+	 * List of source files removed in SMF 2.1.
+	 */
+	private array $smf21SourceFiles = [
+		'DumpDatabase.php',
+		'LockTopic.php',
+	];
+
+	/**
+	 * @var array
+	 *
+	 * List of source files removed in SMF 2.0.
+	 */
+	private array $smf20SourceFiles = [
+		'ModSettings.php',
+	];
+
+	/**
+	 * @var array
+	 *
+	 * List of theme files removed in SMF 1.1.
+	 */
+	private array $smf11ThemeFiles = [
+		'Combat.template.php',
+		'Modlog.template.php',
+		'fader.js',
+		'script.js',
+		'spellcheck.js',
+		'xml_board.js',
+		'xml_topic.js',
+	];
+
+	/****************
+	 * Public methods
+	 ****************/
+
+	public function execute(): bool
+	{
+		$success = true;
+
+		foreach ($this->smf11ThemeFiles as $file) {
+			// This is hard coded, but was originally wrote this way.
+			if (!$this->deleteFile(basename(SMF_SETTINGS_FILE) . '/Themes/default/' . $file)) {
+				$success = false;
+			}
+		}
+
+		foreach ($this->smf20SourceFiles as $file) {
+			// This is hard coded, but was originally wrote this way.
+			if (!$this->deleteFile(Config::$sourcedir . '/' . $file)) {
+				$success = false;
+			}
+		}
+
+		foreach ($this->smf21SourceFiles as $file) {
+			// This is hard coded, but was originally wrote this way.
+			if (!$this->deleteFile(Config::$sourcedir . '/' . $file)) {
+				$success = false;
+			}
+		}
+
+		return $success;
+	}
+
+	/******************
+	 * Internal methods
+	 ******************/
+
+	/**
+	 * Delete a file.  Check permissions first, just in case.
+	 *
+	 * @param string $file
+	 */
+	private function deleteFile(string $file): bool
+	{
+		if (!file_exists($file)) {
+			return true;
+		}
+
+		// NOW do the writable check...
+		if (!is_writable($file)) {
+			@chmod($file, 0755);
+		}
+
+		if (!is_writable($file)) {
+			// Try 755 and 775 first since 777 doesn't always work and could be a risk...
+			$chmod_values = [0755, 0775, 0777];
+
+			foreach ($chmod_values as $val) {
+				@chmod($file, $val);
+
+				// If it's writable, break out of the loop
+				if (is_writable($file)) {
+					break;
+				}
+			}
+
+			@unlink($file);
+		}
+
+		return !file_exists($file);
+	}
+}
+
+?>

Maintenance/Cleanup/index.php

@@ -0,0 +1,9 @@
+<?php
+
+// Try to handle it with the upper level index.php. (it should know what to do.)
+if (file_exists(dirname(__DIR__) . '/index.php'))
+	include (dirname(__DIR__) . '/index.php');
+else
+	exit;
+
+?>

Maintenance/Database/DatabaseInterface.php

@@ -0,0 +1,148 @@
+<?php
+
+/**
+ * Simple Machines Forum (SMF)
+ *
+ * @package SMF
+ * @author Simple Machines https://www.simplemachines.org
+ * @copyright 2024 Simple Machines and individual contributors
+ * @license https://www.simplemachines.org/about/smf/license.php BSD
+ *
+ * @version 3.0 Alpha 2
+ */
+
+declare(strict_types=1);
+
+namespace SMF\Maintenance\Database;
+
+/**
+ * Database Maintenance interface.  Additional database logic is performed and set here.
+ */
+interface DatabaseInterface
+{
+	/****************
+	 * Public methods
+	 ****************/
+
+	/**
+	 * Fetch the database title.
+	 * @return string
+	 */
+	public function getTitle(): string;
+
+	/**
+	 * The minimum version that SMF supports for the database.
+	 * @return string
+	 */
+	public function getMinimumVersion(): string;
+
+	/**
+	 * Get the server version from the server, we must have Config:$db_* defined.
+	 *
+	 * @return string
+	 * 		When false, the server connection failed or an error occurred.
+	 * 		Otherwise a string is returned containing the server version.
+	 */
+	public function getServerVersion(): bool|string;
+
+	/**
+	 * Is this database supported.
+	 *
+	 * @return bool True if we can use this database, false otherwise.
+	 */
+	public function isSupported(): bool;
+
+	/**
+	 * Skip issuing a select database command.
+	 *
+	 * @return bool When true, we do not select a database.
+	 */
+	public function skipSelectDatabase(): bool;
+
+	/**
+	 * Default username for a database connection.
+	 *
+	 * @return string
+	 */
+	public function getDefaultUser(): string;
+
+	/**
+	 * Default password for a database connection.
+	 *
+	 * @return string
+	 */
+	public function getDefaultPassword(): string;
+
+	/**
+	 * Default host for a database connection.
+	 *
+	 * @return string
+	 */
+	public function getDefaultHost(): string;
+
+	/**
+	 * Default port for a database connection.
+	 *
+	 * @return int
+	 */
+	public function getDefaultPort(): int;
+
+	/**
+	 * Default database name for a database connection.
+	 *
+	 * @return string
+	 */
+	public function getDefaultName(): string;
+
+	/**
+	 * Performs checks to ensure the server is in a sane configuration.
+	 *
+	 * @return bool
+	 */
+	public function checkConfiguration(): bool;
+
+	/**
+	 * Performs checks to ensure we have proper permissions to the database in order to perform operations.
+	 *
+	 * @return bool
+	 */
+	public function hasPermissions(): bool;
+
+	/**
+	 * Validate a database prefix.
+	 * When an error occurs, use throw new exception, this will be captured.
+	 *
+	 * @return bool
+	 */
+	public function validatePrefix(&$string): bool;
+
+	/**
+	 * Checks that the server has the proper support for UTF-8 content.
+	 * When an error occurs, use throw new exception, this will be captured.
+	 *
+	 * @return bool
+	 */
+	public function utf8Configured(): bool;
+
+	/**
+	 * Perform additional changes to our SQL connection in order to perform commands that are not strict SQL.
+	 *
+	 * @param string $mode The SQL mode we wish to be in, either 'default' or 'strict'.
+	 * @return bool
+	 */
+	public function setSqlMode(string $mode = 'default'): bool;
+
+	/**
+	 * When an error occurs with a query ran through a wrapper, we send errors here.
+	 *
+	 * @param string $error_msg as returend by the database interfaces call.
+	 * @param string $query Query we ran
+	 * @return mixed
+	 * 				False if we should not do anything,
+	 * 				True if we should stop for error.
+	 * 				Result from a query can also be returned, if we are able to correct the query.
+	 */
+	public function processError(string $error_msg, string $query): mixed;
+}
+
+?>