Merge pull request #8502 from Sesquipedalian/3.0/msg_topic_save

[3.0] Uses a more OOP-like approach to saving messages and topics to the database

Author: Sesquipedalian

Sources/Actions/Admin/Permissions.php

@@ -2368,6 +2368,7 @@ public static function loadIllegalPermissions(): array
 
 		self::$illegal = array_unique(self::$illegal);
 
+		// Call the deprecated integrate_load_illegal_permissions hook.
 		self::integrateLoadIllegalPermissions();
 
 		return self::$illegal;
@@ -3208,7 +3209,7 @@ protected static function loadAllPermissions(): void
 		// We also need to know which groups can't be given the bbc_html permission.
 		self::loadIllegalBBCHtmlGroups();
 
-		// Backward compatibility with the integrate_load_permissions hook.
+		// Call the deprecated integrate_load_permissions hook.
 		self::integrateLoadPermissions();
 
 		// Figure out which permissions should be hidden.
@@ -3420,7 +3421,7 @@ protected static function updateBoardManagers(): void
 	protected static function integrateLoadPermissions(): void
 	{
 		// Don't bother if nothing is using this hook.
-		if (empty(Config::$modSettings['integrate_load_permissions'])) {
+		if (empty(Config::$backward_compatibility) || empty(Config::$modSettings['integrate_load_permissions'])) {
 			return;
 		}
 
@@ -3506,7 +3507,7 @@ protected static function integrateLoadPermissions(): void
 	protected static function integrateLoadIllegalPermissions(): void
 	{
 		// Don't bother if nothing is using this hook.
-		if (empty(Config::$modSettings['integrate_load_illegal_permissions'])) {
+		if (empty(Config::$backward_compatibility) || empty(Config::$modSettings['integrate_load_illegal_permissions'])) {
 			return;
 		}
 
@@ -3546,7 +3547,7 @@ protected static function integrateLoadIllegalPermissions(): void
 	protected static function integrateLoadIllegalGuestPermissions(): void
 	{
 		// Don't bother if nothing is using this hook.
-		if (empty(Config::$modSettings['integrate_load_illegal_guest_permissions'])) {
+		if (empty(Config::$backward_compatibility) || empty(Config::$modSettings['integrate_load_illegal_guest_permissions'])) {
 			return;
 		}
 

Sources/Actions/Display.php

@@ -1360,10 +1360,14 @@ protected function buildButtons(): void
 		}
 
 		// Allow adding new buttons easily.
-		// Note: Utils::$context['normal_buttons'] and Utils::$context['mod_buttons'] are added for backward compatibility with 2.0, but are deprecated and should not be used
+		// MOD AUTHORS: A future version of SMF will stop passing Utils::$context['normal_buttons'] to this hook.
+		// You should just interact with Utils::$context['normal_buttons'] directly in your hooked code.
 		IntegrationHook::call('integrate_display_buttons', [&Utils::$context['normal_buttons']]);
-		// Note: integrate_mod_buttons is no longer necessary and deprecated, but is kept for backward compatibility with 2.0
-		IntegrationHook::call('integrate_mod_buttons', [&Utils::$context['mod_buttons']]);
+
+		// NOD AUTHORS: integrate_mod_buttons is deprecated. Use integrate_display_buttons instead.
+		if (!empty(Config::$backward_compatibility)) {
+			IntegrationHook::call('integrate_mod_buttons', [&Utils::$context['mod_buttons']]);
+		}
 
 		// If any buttons have a 'test' check, run those tests now to keep things clean.
 		foreach (['normal_buttons', 'mod_buttons'] as $button_strip) {

Sources/Actions/MessageIndex.php

@@ -1119,7 +1119,8 @@ protected function buildButtons(): void
 		}
 
 		// Allow adding new buttons easily.
-		// Note: Utils::$context['normal_buttons'] is added for backward compatibility with 2.0, but is deprecated and should not be used
+		// MOD AUTHORS: A future version of SMF will stop passing Utils::$context['normal_buttons'] to this hook.
+		// You should just interact with Utils::$context['normal_buttons'] directly in your hooked code.
 		IntegrationHook::call('integrate_messageindex_buttons', [&Utils::$context['normal_buttons']]);
 	}
 }

Sources/Actions/Moderation/Home.php

@@ -537,10 +537,14 @@ protected function reportedMembers(): void
 	/**
 	 * Provides a home for the deprecated integrate_mod_centre_blocks hook.
 	 *
-	 * MOD AUTHORS: Please use the integrate_moderation_home_blocks instead.
+	 * MOD AUTHORS: Please use integrate_moderation_home_blocks instead.
 	 */
 	protected static function integrateModBlocks(): void
 	{
+		if (empty(Config::$backward_compatibility)) {
+			return;
+		}
+
 		$valid_blocks = [];
 
 		IntegrationHook::call('integrate_mod_centre_blocks', [&$valid_blocks]);

Sources/Actions/Profile/Notification.php

@@ -415,8 +415,6 @@ public function configuration(bool $defaultSettings = false): void
 			}
 		}
 
-		// Now, now, we could pass this through global but we should really get into the habit of
-		// passing content to hooks, not expecting hooks to splatter everything everywhere.
 		IntegrationHook::call('integrate_alert_types', [&$this->alert_types, &$this->group_options]);
 
 		// Now we have to do some permissions testing - but only if we're not loading this from the admin center

Sources/Db/DatabaseApi.php

@@ -18,7 +18,9 @@
 use SMF\BackwardCompatibility;
 use SMF\Config;
 use SMF\ErrorHandler;
+use SMF\IP;
 use SMF\Utils;
+use SMF\Uuid;
 
 /**
  * Class DatabaseApi
@@ -304,6 +306,113 @@ abstract class DatabaseApi
 		'user_likes',
 	];
 
+	/****************
+	 * Public methods
+	 ****************/
+
+	/**
+	 * Figures out the best type indicators to use in SMF's query placeholder
+	 * strings and/or insert column type definitions for a given set of columns.
+	 *
+	 * In most cases, this is simply a matter of looking up the expected data
+	 * type for the target column and then translating it to the type indicator
+	 * string that Db::$db->quote() and Db::$db->insert() would expect for that
+	 * column's data type. There are a couple of special cases that we need to
+	 * check for, though, so this method takes care of that.
+	 *
+	 * Calling this method is usually only necessary if we are trying to save
+	 * values to custom columns that were added by mods.
+	 *
+	 * @param string $table_name The name of a table.
+	 * @param array $column_values Array where keys are possible column names
+	 *    and values are the values we plan to set.
+	 * @return array List of recognized column names and their corresponding
+	 *    data type indicators.
+	 */
+	public function getTypeIndicators(string $table_name, array $column_values): array
+	{
+		$columns = $this->list_columns($table_name, true);
+
+		$types = [];
+
+		foreach ($column_values as $column_name => $value) {
+			if (!isset($columns[$column_name])) {
+				continue;
+			}
+
+			switch (strtolower($columns[$column_name]['type'])) {
+				case 'decimal':
+				case 'numeric':
+				case 'float':
+				case 'double':
+				case 'real':
+				case 'double precision':
+				case 'money':
+					$type = 'float';
+					break;
+
+				case 'integer':
+				case 'int':
+				case 'tinyint':
+				case 'smallint':
+				case 'mediumint':
+				case 'bigint':
+				case 'bool':
+				case 'boolean':
+					$type = 'int';
+					break;
+
+				case 'year':
+					$type = 'int';
+					break;
+
+				case 'datetime':
+				case 'timestamp':
+					$type = 'datetime';
+					break;
+
+				case 'date':
+					$type = 'date';
+					break;
+
+				case 'time':
+					$type = 'time';
+					break;
+
+				case 'inet':
+					$type = 'inet';
+					break;
+
+				case 'uuid':
+					$type = 'uuid';
+					break;
+
+				case 'json':
+				case 'enum':
+				case 'set':
+					$type = 'string';
+					break;
+
+				default:
+					$test = is_array($value) ? reset($value) : $value;
+
+					if (IP::create($test)->isValid()) {
+						$types[$column_name] = 'inet';
+					} elseif ($test instanceof Uuid || (string) (@Uuid::createFromString($test)) !== Uuid::NIL_UUID) {
+						$types[$column_name] = 'uuid';
+					} else {
+						$type = 'string';
+					}
+
+					break;
+			}
+
+			$types[$column_name] = $type;
+		}
+
+		return $types;
+	}
+
 	/***********************
 	 * Public static methods
 	 ***********************/

Sources/Forum.php

@@ -416,11 +416,15 @@ public function __construct()
 
 		// Allow modifying $unlogged_actions easily.
 		// Deprecated: Implement ActionInterface::isSimpleAction() instead of this hook.
-		IntegrationHook::call('integrate_pre_log_stats', [&self::$unlogged_actions]);
+		if (!empty(Config::$backward_compatibility)) {
+			IntegrationHook::call('integrate_pre_log_stats', [&self::$unlogged_actions]);
+		}
 
 		// Allow modifying $guest_access_actions easily.
 		// Deprecated: Implement ActionInterface::isRestrictedGuestAccessAllowed() instead of this hook.
-		IntegrationHook::call('integrate_guest_actions', [&self::$guest_access_actions]);
+		if (!empty(Config::$backward_compatibility)) {
+			IntegrationHook::call('integrate_guest_actions', [&self::$guest_access_actions]);
+		}
 	}
 
 	/**