[ticket/10937] Comment removal functions: Restore backward compatibility

PHPBB3-10937

phpBB/includes/functions_admin.php

@@ -2293,6 +2293,21 @@ function auto_prune($forum_id, $prune_mode, $prune_flags, $prune_days, $prune_fr
 	return;
 }
 
+/**
+* remove_comments will strip the sql comment lines out of an uploaded sql file
+* specifically for mssql and postgres type files in the install....
+*
+* @deprecated		Use phpbb_remove_comments() instead.
+*/
+function remove_comments(&$output)
+{
+	// Remove /* */ comments (http://ostermiller.org/findcomment.html)
+	$output = preg_replace('#/\*(.|[\r\n])*?\*/#', "\n", $output);
+
+	// Return by reference and value.
+	return $output;
+}
+
 /**
 * Cache moderators, called whenever permissions are changed via admin_permissions. Changes of username
 * and group names must be carried through for the moderators table

phpBB/includes/functions_install.php

@@ -50,6 +50,7 @@ function get_available_dbms($dbms = false, $return_unavailable = false, $only_20
 			'SCHEMA'		=> 'firebird',
 			'MODULE'		=> 'interbase',
 			'DELIM'			=> ';;',
+			'COMMENTS'		=> 'remove_remarks',
 			'DRIVER'		=> 'firebird',
 			'AVAILABLE'		=> true,
 			'2.0.x'			=> false,
@@ -59,6 +60,7 @@ function get_available_dbms($dbms = false, $return_unavailable = false, $only_20
 			'SCHEMA'		=> 'mysql_41',
 			'MODULE'		=> 'mysqli',
 			'DELIM'			=> ';',
+			'COMMENTS'		=> 'remove_remarks',
 			'DRIVER'		=> 'mysqli',
 			'AVAILABLE'		=> true,
 			'2.0.x'			=> true,
@@ -68,6 +70,7 @@ function get_available_dbms($dbms = false, $return_unavailable = false, $only_20
 			'SCHEMA'		=> 'mysql',
 			'MODULE'		=> 'mysql',
 			'DELIM'			=> ';',
+			'COMMENTS'		=> 'remove_remarks',
 			'DRIVER'		=> 'mysql',
 			'AVAILABLE'		=> true,
 			'2.0.x'			=> true,
@@ -77,6 +80,7 @@ function get_available_dbms($dbms = false, $return_unavailable = false, $only_20
 			'SCHEMA'		=> 'mssql',
 			'MODULE'		=> 'mssql',
 			'DELIM'			=> 'GO',
+			'COMMENTS'		=> 'remove_comments',
 			'DRIVER'		=> 'mssql',
 			'AVAILABLE'		=> true,
 			'2.0.x'			=> true,
@@ -86,6 +90,7 @@ function get_available_dbms($dbms = false, $return_unavailable = false, $only_20
 			'SCHEMA'		=> 'mssql',
 			'MODULE'		=> 'odbc',
 			'DELIM'			=> 'GO',
+			'COMMENTS'		=> 'remove_comments',
 			'DRIVER'		=> 'mssql_odbc',
 			'AVAILABLE'		=> true,
 			'2.0.x'			=> true,
@@ -95,6 +100,7 @@ function get_available_dbms($dbms = false, $return_unavailable = false, $only_20
 			'SCHEMA'		=> 'mssql',
 			'MODULE'		=> 'sqlsrv',
 			'DELIM'			=> 'GO',
+			'COMMENTS'		=> 'remove_comments',
 			'DRIVER'		=> 'mssqlnative',
 			'AVAILABLE'		=> true,
 			'2.0.x'			=> false,
@@ -104,6 +110,7 @@ function get_available_dbms($dbms = false, $return_unavailable = false, $only_20
 			'SCHEMA'		=> 'oracle',
 			'MODULE'		=> 'oci8',
 			'DELIM'			=> '/',
+			'COMMENTS'		=> 'remove_comments',
 			'DRIVER'		=> 'oracle',
 			'AVAILABLE'		=> true,
 			'2.0.x'			=> false,
@@ -113,6 +120,7 @@ function get_available_dbms($dbms = false, $return_unavailable = false, $only_20
 			'SCHEMA'		=> 'postgres',
 			'MODULE'		=> 'pgsql',
 			'DELIM'			=> ';',
+			'COMMENTS'		=> 'remove_comments',
 			'DRIVER'		=> 'postgres',
 			'AVAILABLE'		=> true,
 			'2.0.x'			=> true,
@@ -122,6 +130,7 @@ function get_available_dbms($dbms = false, $return_unavailable = false, $only_20
 			'SCHEMA'		=> 'sqlite',
 			'MODULE'		=> 'sqlite',
 			'DELIM'			=> ';',
+			'COMMENTS'		=> 'remove_remarks',
 			'DRIVER'		=> 'sqlite',
 			'AVAILABLE'		=> true,
 			'2.0.x'			=> false,
@@ -465,16 +474,39 @@ function connect_check_db($error_connect, &$error, $dbms_details, $table_prefix,
 
 /**
 * Removes comments from schema files
+*
+* @deprecated		Use phpbb_remove_comments() instead.
 */
-function remove_comments($sql)
+function remove_remarks(&$sql)
 {
-	// Remove /* */ comments (http://ostermiller.org/findcomment.html)
-	$sql = preg_replace('#/\*(.|[\r\n])*?\*/#', "\n", $sql);
-
 	// Remove # style comments
 	$sql = preg_replace('/\n{2,}/', "\n", preg_replace('/^#.*$/m', "\n", $sql));
 
-	return $sql;
+	// Return by reference
+}
+
+/**
+* Removes comments from $input.
+*
+* @param string $input		Input string
+*
+* @return string			Input string with comments removed
+*/
+function phpbb_remove_comments($input)
+{
+	if (!function_exists('remove_comments'))
+	{
+		global $phpbb_root_path, $phpEx;
+		require($phpbb_root_path . 'includes/functions_admin.' . $phpEx);
+	}
+
+	// Remove /* */ comments
+	remove_comments($input);
+
+	// Remove # style comments
+	remove_remarks($input);
+
+	return $input;
 }
 
 /**

phpBB/install/install_install.php

@@ -1164,7 +1164,7 @@ class install_install extends module
 
 		$sql_query = preg_replace('#phpbb_#i', $data['table_prefix'], $sql_query);
 
-		$sql_query = remove_comments($sql_query);
+		$sql_query = phpbb_remove_comments($sql_query);
 
 		$sql_query = split_sql_file($sql_query, $delimiter);
 
@@ -1202,7 +1202,7 @@ class install_install extends module
 		// Change language strings...
 		$sql_query = preg_replace_callback('#\{L_([A-Z0-9\-_]*)\}#s', 'adjust_language_keys_callback', $sql_query);
 
-		$sql_query = remove_comments($sql_query);
+		$sql_query = phpbb_remove_comments($sql_query);
 		$sql_query = split_sql_file($sql_query, ';');
 
 		foreach ($sql_query as $sql)

tests/test_framework/phpbb_database_test_connection_manager.php

@@ -243,7 +243,7 @@ class phpbb_database_test_connection_manager
 		$filename = $directory . $schema . '_schema.sql';
 
 		$queries = file_get_contents($filename);
-		$sql = remove_comments($queries);
+		$sql = phpbb_remove_comments($queries);
 		
 		$sql = split_sql_file($sql, $this->dbms['DELIM']);