Merge pull request phpbb#3694 from marc1706/ticket/13930

[ticket/13930] Check for correct spacing between keyword & parenthesis

* marc1706/ticket/13930:
  [ticket/13930] Add missing spaces to code
  [ticket/13930] Use OpeningParenthesisSniff in legacy ruleset
  [ticket/13930] Remove not needed return statements
  [ticket/13930] Add missing spaces to code
  [ticket/13930] Check for correct spacing between keyword & parenthesis

build/code_sniffer/phpbb/Sniffs/ControlStructures/OpeningParenthesisSniff.php

@@ -0,0 +1,60 @@
+<?php
+/**
+ *
+ * This file is part of the phpBB Forum Software package.
+ *
+ * @copyright (c) phpBB Limited <https://www.phpbb.com>
+ * @license GNU General Public License, version 2 (GPL-2.0)
+ *
+ * For full copyright and license information, please see
+ * the docs/CREDITS.txt file.
+ *
+ */
+
+/**
+ * Checks that there is exactly one space between the keyword and the opening
+ * parenthesis of a control structures.
+ */
+class phpbb_Sniffs_ControlStructures_OpeningParenthesisSniff implements PHP_CodeSniffer_Sniff
+{
+	/**
+	 * Registers the tokens that this sniff wants to listen for.
+	 */
+	public function register()
+	{
+		return array(
+			T_IF,
+			T_FOREACH,
+			T_WHILE,
+			T_FOR,
+			T_SWITCH,
+			T_ELSEIF,
+			T_CATCH,
+		);
+	}
+
+	/**
+	 * Processes this test, when one of its tokens is encountered.
+	 *
+	 * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
+	 * @param int                  $stackPtr  The position of the current token in the
+	 *                                        stack passed in $tokens.
+	 *
+	 * @return void
+	 */
+	public function process(PHP_CodeSniffer_File $phpcsFile, $stackPtr)
+	{
+		$tokens = $phpcsFile->getTokens();
+
+		if ($tokens[$stackPtr + 1]['content'] === '(')
+		{
+			$error = 'There should be exactly one space between the keyword and opening parenthesis';
+			$phpcsFile->addError($error, $stackPtr, 'NoSpaceBeforeOpeningParenthesis');
+		}
+		else if ($tokens[$stackPtr + 1]['content'] !== ' ')
+		{
+			$error = 'There should be exactly one space between the keyword and opening parenthesis';
+			$phpcsFile->addError($error, $stackPtr, 'IncorrectSpaceBeforeOpeningParenthesis');
+		}
+	}
+}

build/code_sniffer/ruleset-php-legacy.xml

@@ -86,4 +86,7 @@
  <!-- The ?> closing tag MUST be omitted from files containing only PHP. -->
  <rule ref="Zend.Files.ClosingTag" />
 
+ <!-- There MUST be one space between control structure and opening parenthesis -->
+ <rule ref="./phpbb/Sniffs/ControlStructures/OpeningParenthesisSniff.php" />
+
 </ruleset>

phpBB/includes/acp/acp_database.php

@@ -1558,7 +1558,7 @@ function write_data($table_name)
 		{
 			$this->write_data_mssql($table_name);
 		}
-		else if($db->get_sql_layer() === 'mssqlnative')
+		else if ($db->get_sql_layer() === 'mssqlnative')
 		{
 			$this->write_data_mssqlnative($table_name);
 		}

phpBB/includes/acp/acp_extensions.php

@@ -76,7 +76,7 @@ function main()
 			{
 				$md_manager->get_metadata('all');
 			}
-			catch(\phpbb\extension\exception $e)
+			catch (\phpbb\extension\exception $e)
 			{
 				trigger_error($e, E_USER_WARNING);
 			}
@@ -352,7 +352,7 @@ public function list_enabled_exts(\phpbb\extension\manager $phpbb_extension_mana
 				$enabled_extension_meta_data[$name]['S_VERSIONCHECK'] = true;
 				$enabled_extension_meta_data[$name]['U_VERSIONCHECK_FORCE'] = $this->u_action . '&action=details&versioncheck_force=1&ext_name=' . urlencode($md_manager->get_metadata('name'));
 			}
-			catch(\phpbb\extension\exception $e)
+			catch (\phpbb\extension\exception $e)
 			{
 				$this->template->assign_block_vars('disabled', array(
 					'META_DISPLAY_NAME'		=> $this->user->lang('EXTENSION_INVALID_LIST', $name, $e),
@@ -408,7 +408,7 @@ public function list_disabled_exts(\phpbb\extension\manager $phpbb_extension_man
 				$disabled_extension_meta_data[$name]['S_VERSIONCHECK'] = true;
 				$disabled_extension_meta_data[$name]['U_VERSIONCHECK_FORCE'] = $this->u_action . '&action=details&versioncheck_force=1&ext_name=' . urlencode($md_manager->get_metadata('name'));
 			}
-			catch(\phpbb\extension\exception $e)
+			catch (\phpbb\extension\exception $e)
 			{
 				$this->template->assign_block_vars('disabled', array(
 					'META_DISPLAY_NAME'		=> $this->user->lang('EXTENSION_INVALID_LIST', $name, $e),
@@ -467,7 +467,7 @@ public function list_available_exts(\phpbb\extension\manager $phpbb_extension_ma
 				$available_extension_meta_data[$name]['S_VERSIONCHECK'] = true;
 				$available_extension_meta_data[$name]['U_VERSIONCHECK_FORCE'] = $this->u_action . '&action=details&versioncheck_force=1&ext_name=' . urlencode($md_manager->get_metadata('name'));
 			}
-			catch(\phpbb\extension\exception $e)
+			catch (\phpbb\extension\exception $e)
 			{
 				$this->template->assign_block_vars('disabled', array(
 					'META_DISPLAY_NAME'		=> $this->user->lang('EXTENSION_INVALID_LIST', $name, $e),

phpBB/includes/acp/acp_styles.php

@@ -995,7 +995,7 @@ protected function list_style(&$style, $level)
 
 		// Assign template variables
 		$this->template->assign_block_vars('styles_list', $row);
-		foreach($actions as $action)
+		foreach ($actions as $action)
 		{
 			$this->template->assign_block_vars('styles_list.actions', $action);
 		}

phpBB/includes/functions_convert.php

@@ -966,7 +966,7 @@ function get_remote_avatar_dim($src, $axis)
 	$protocol = (isset($url_info['scheme'])) ? $url_info['scheme'] : 'http';
 	if (empty($port))
 	{
-		switch(strtolower($protocol))
+		switch (strtolower($protocol))
 		{
 			case 'ftp':
 				$port = 21;

phpBB/includes/ucp/ucp_notifications.php

@@ -52,11 +52,11 @@ public function main($id, $mode)
 
 					$notification_methods = $phpbb_notifications->get_subscription_methods();
 
-					foreach($phpbb_notifications->get_subscription_types() as $group => $subscription_types)
+					foreach ($phpbb_notifications->get_subscription_types() as $group => $subscription_types)
 					{
-						foreach($subscription_types as $type => $data)
+						foreach ($subscription_types as $type => $data)
 						{
-							foreach($notification_methods as $method => $method_data)
+							foreach ($notification_methods as $method => $method_data)
 							{
 								if ($request->is_set_post(str_replace('.', '_', $type . '_' . $method_data['id'])) && (!isset($subscriptions[$type]) || !in_array($method_data['id'], $subscriptions[$type])))
 								{
@@ -180,13 +180,13 @@ public function output_notification_types($subscriptions, \phpbb\notification\ma
 	{
 		$notification_methods = $phpbb_notifications->get_subscription_methods();
 
-		foreach($phpbb_notifications->get_subscription_types() as $group => $subscription_types)
+		foreach ($phpbb_notifications->get_subscription_types() as $group => $subscription_types)
 		{
 			$template->assign_block_vars($block, array(
 				'GROUP_NAME'	=> $user->lang($group),
 			));
 
-			foreach($subscription_types as $type => $data)
+			foreach ($subscription_types as $type => $data)
 			{
 				$template->assign_block_vars($block, array(
 					'TYPE'				=> $type,
@@ -197,7 +197,7 @@ public function output_notification_types($subscriptions, \phpbb\notification\ma
 					'SUBSCRIBED'		=> (isset($subscriptions[$type])) ? true : false,
 				));
 
-				foreach($notification_methods as $method => $method_data)
+				foreach ($notification_methods as $method => $method_data)
 				{
 					$template->assign_block_vars($block . '.notification_methods', array(
 						'METHOD'			=> $method_data['id'],
@@ -227,7 +227,7 @@ public function output_notification_methods(\phpbb\notification\manager $phpbb_n
 	{
 		$notification_methods = $phpbb_notifications->get_subscription_methods();
 
-		foreach($notification_methods as $method => $method_data)
+		foreach ($notification_methods as $method => $method_data)
 		{
 			$template->assign_block_vars($block, array(
 				'METHOD'			=> $method_data['id'],

phpBB/phpbb/cache/driver/memcache.php

@@ -50,7 +50,7 @@ function __construct()
 		parent::__construct();
 
 		$this->memcache = new \Memcache;
-		foreach(explode(',', PHPBB_ACM_MEMCACHE) as $u)
+		foreach (explode(',', PHPBB_ACM_MEMCACHE) as $u)
 		{
 			$parts = explode('/', $u);
 			$this->memcache->addServer(trim($parts[0]), trim($parts[1]));

phpBB/phpbb/captcha/plugins/qa.php

@@ -350,7 +350,7 @@ function install()
 				),
 		);
 
-		foreach($schemas as $table => $schema)
+		foreach ($schemas as $table => $schema)
 		{
 			if (!$db_tool->sql_table_exists($table))
 			{

phpBB/phpbb/log/log.php

@@ -535,7 +535,7 @@ public function get_logs($mode, $count_logs = true, $limit = 0, $offset = 0, $fo
 			'ORDER_BY' => $sort_by,
 		);
 
-		if($log_time)
+		if ($log_time)
 		{
 			$get_logs_sql_ary['WHERE'] = 'l.log_time >= ' . (int) $log_time . '
 					AND ' . $get_logs_sql_ary['WHERE'];

phpBB/phpbb/search/fulltext_sphinx.php

@@ -146,7 +146,7 @@ public function __construct(&$error, $phpbb_root_path, $phpEx, $auth, $config, $
 		// Initialize \phpbb\db\tools object
 		$this->db_tools = new \phpbb\db\tools($this->db);
 
-		if(!$this->config['fulltext_sphinx_id'])
+		if (!$this->config['fulltext_sphinx_id'])
 		{
 			set_config('fulltext_sphinx_id', unique_id());
 		}

phpBB/viewtopic.php

@@ -588,7 +588,7 @@
 	'topic_logs'			=> array('VIEW_TOPIC_LOGS', $auth->acl_get('m_', $forum_id)),
 );
 
-foreach($quickmod_array as $option => $qm_ary)
+foreach ($quickmod_array as $option => $qm_ary)
 {
 	if (!empty($qm_ary[1]))
 	{